PixiesPixel
PixiesPixel copied to clipboard
A cross-platform realtime online multiplayer PvP game made with Godot and GDScript. Voted runner up (out of 243 teams) at NUS Orbital 2019.
PixiesPixel 
A cross-platform realtime online multiplayer PvP game made with Godot.
Try it out: executables for Windows, MacOS, Linux, and Android are available.
Instructions
Download the necessary files for your operating system (there is no need to install any other additional files/dependencies)
-
To test locally:
- Launch two instances of the game on your machine (MacOS users might have to rename the other file), leave the default IP address as it is, host on one instance first, then join on the other
-
To connect with players on the same Wifi network:
- To host a game: Simply press
host
and you should automatically be transported to the Lobby. Your private IPv4 address should also appear on the top left hand corner - To join a game: Enter the host’s IPv4 address. Press
join
, and if connected successfully, you should be transported to the Lobby (the connection ought to be almost instant)
- To host a game: Simply press
-
To connect with players outside of your Wifi network:
- You will need to either set up port forwarding to allow your IP address to be publicly available to networks outside of your LAN
- Or use a Virtual Private Network on-demand client like Hamachi to extend your LAN-like environment (recommended; tested and working)
Naming Conventions
-
Classes/scenes/nodes: pascal case <
MyScene
> -
Variables/functions: snake case <
my_var
> -
Signals: past tense <
door_opened
> -
Constants: upper caps snake case <
MY_CONSTANT
>
Warnings
Do not move/rename files using terminal/file explorer. Use Godot's inbuilt file system to move/rename files in order to not break the references.
Credits
For the assets used (sprites/tilemaps/music/fonts):
- Adventurer character
- Pirate character
- Archer character
- Dungeon map
- Grassy Plains map
- All music by Eric Matyas of www.soundimage.org
- m5x7 and Monogram fonts
A copy of the original licenses/permissions from the authors (if applicable) can also be found in the respective subdirectories of the
/Assets
directory.
License
Unless otherwise stated, all GDScript
code written for this project is licensed under the MIT License. For the licenses regarding the assets used, please refer to the appropriate subdirectories within the /Assets
directory for a copy of the original license/permissions (if applicable).