https://github.com/apetenchea/spaceinvaders
Multiplayer game made from scratch.
https://github.com/apetenchea/spaceinvaders
java-8 multiplayer-game space-invaders
Last synced: 11 months ago
JSON representation
Multiplayer game made from scratch.
- Host: GitHub
- URL: https://github.com/apetenchea/spaceinvaders
- Owner: apetenchea
- License: mit
- Created: 2016-12-04T20:33:28.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-03-07T08:48:13.000Z (over 4 years ago)
- Last Synced: 2025-06-03T07:28:26.681Z (about 1 year ago)
- Topics: java-8, multiplayer-game, space-invaders
- Language: Java
- Homepage:
- Size: 899 KB
- Stars: 18
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/apetenchea/SpaceInvaders)
# SpaceInvaders - a multiplayer game made from scratch.
I've always wondered what is going on behind a multiplayer game, so I decided to make one in order to find out!
Inspired by the well known classic, up to 3 players may team up in an online battle agains the invaders.
The required Java version is [**Java 8**](http://www.oracle.com/technetwork/java/javase/overview/java8-2100321.html) or newer.
## Building
Using maven:
```
mvn package
```
Just compiling the source into *.class* files:
1. Go to where the source files are (src/main/java)
2. Run:
```Shell
mkdir target
```
3. Replace path_to_gson with the path to gson-2.8.0.jar and run::
```Shell
javac -d target -classpath path_to_gson -sourcepath . spaceinvaders/SpaceInvaders.java
```
## Usage
The game consists of two parts: a client and a server.
### Server
Starting up:
```
java -jar spaceinvaders*.jar server port [verbose]
```
The script [server.sh](https://github.com/apetenchea/SpaceInvaders/blob/master/server.sh) contains an example of how to start a server on your machine, on port 5412. If you add the ***verbose*** argument, the logging is going to be more verbose.
Using the *.jar* file is recommended. Because when running a `.jar` Java handles resourced differently from when you are running *.class* files, a small modification in the code is required in the second case.
In the class [Config](https://github.com/apetenchea/SpaceInvaders/blob/master/src/main/java/spaceinvaders/Config.java), there is a field:
```Java
private static final transient Boolean JAR_FILE = true;
```
This field must be set to `false` in case the target is not a *.jar* file.
### Client
Starting up:
```
java -jar spaceinvaders*.jar client [verbose]
```
The script [client.sh](https://github.com/apetenchea/SpaceInvaders/blob/master/client.sh) contains an example of how to run the client. If you add ***verbose*** as an argument, the logging is going to be more verbose. In order to play the game, you must choose an username, how many players your team shall you team have, and then connect to a running server.
## Configuration files
- [app.json](https://github.com/apetenchea/SpaceInvaders/blob/master/src/main/resources/config/app.json) contains runtime information about the application. In case of a lan party, the ***lanGame*** field should be set to ***true***, thus configuring the game to prefer the UDP protocol over TCP.
- [client.json](https://github.com/apetenchea/SpaceInvaders/blob/master/src/main/resources/config/client.json) contains the client's configuration.
- [game.json](https://github.com/apetenchea/SpaceInvaders/blob/master/src/main/resources/config/game.json) is used to configure the gameplay.
- [resources.json](https://github.com/apetenchea/SpaceInvaders/blob/master/src/main/resources/config/resources.json) is used to locate resources.
## Code
The code follows the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) and is checked using [checkstyle](http://checkstyle.sourceforge.net/).
## Documenation
Documenation is generated using [javadoc](http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html).
The script [getDoc.sh](https://github.com/apetenchea/SpaceInvaders/blob/master/getDoc.sh) handles this.
## Credits for the materials used in this game
Icons made by Freepik, Madebyoliver, Roundicons, Alfredo Hernandez from www.flaticon.com are licensed by CC 3.0 BY.
Some of the original icons were edited by [luciamoga](https://github.com/luciamoga).
## Screenshot
