-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
minor fix, update project version to 1.3-rc
- Loading branch information
otter
authored and
otter
committed
Nov 9, 2017
1 parent
469f0fb
commit 57896f1
Showing
9 changed files
with
83 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,28 @@ | ||
# websocket-gameroom | ||
# websocket-gameroom | ||
A game room implement by Spring WebSocket, a bootstrap for group users to different room with maximum number of users for each room. | ||
|
||
## Getting Started | ||
Not design for run alone, see the quick start below to apply it to your project. | ||
|
||
## Quick Start | ||
1. add this annotation | ||
```@EnableConfigurationProperties(WebSocketGameRoom.class)``` | ||
2. Build your own game model extends AbstractGame | ||
3. Build your own game model builder extends AeroplaneChessBuilder | ||
4. Implement GameService interface and pass the your own game model as type | ||
5. Configure the destination prefix of the application and the message broker by the configuration | ||
|
||
## Configuration | ||
| name | type | default | description | | ||
| ---- |:----:| :-------:| ----------:| | ||
| websocket.destination.prefix.broker | String | null | prefix of the message broker | | ||
| websocket.destination.application | String | null | prefix of application | | ||
| websocket.stomp.endpoint | String | null | stomp client end point | | ||
| gameroom.config.numof.player | int | 0 | max num of player for each room | | ||
|
||
## Demo | ||
A [aeroplane chess](https://github.com/kan01234/aeroplanes-chess) game built by this project. | ||
|
||
## Prerequisites | ||
* JAVA 8 Runtime | ||
* Maven 3.3 or above |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters