chippmann/nakama-godot-demo

A demo project with Godot engine and Nakama server.

Nakama Godot Demo

This demo shows how to use Nakama with the Nakama Godot client.

It showcases the following Nakama features:

• Authentication, sessions, and disconnection.
• Game storage.
• Sockets and managing connections.
• Real-time chat.
• In-app notifications with popups.
• Character color customization.
• Platforming mechanics and synchronizing players. Multiple players can interact together.

It also shows good practices to design user interface and structure your Godot projects.

Screenshots

Here is a view of the game world, where players can chat, move around, interact with one-another, or change their color.

The character creation screen allows you to pick a color from a predefined color palette.

Testing the project

To test the project, you need first to install the server and get it running, then run two instances of Godot.

To install and start the server:

1. Install Docker.
   • On Windows.
   • On Mac.
   • On Ubuntu: sudo apt install docker docker-compose.
2. Open your terminal and navigate to the nakama/ directory.
3. Run the command docker-compose -f docker-compose.yml up or run boot.bat in Windows.

Docker should automatically download, then install Nakama and CockroachDB for you before starting the local server. The server should emit the message "Startup done".

Then, to test the project in Godot, you need to open or run the project in two separate instances.

Registering and logging in

To log into the game, you need first to register a dummy local account. To do so, on the initial game screen:

1. Click on the "register" button.
2. Enter any email and password.
   • The email doesn't need to exist, but it needs to be of the form email@domain.extension. For example, test@test.com would work.
   • The password needs to contain at least 8 characters.

Once you registered an account, you can log in, create a new character, and enter the game.

Using the Nakama admin area

Nakama's server provides a web admin interface to see, modify, or purge users and other game data. To access it:

1. Start the Nakama server.
2. Navigate to http://127.0.0.1:7351/ in your web browser.
3. Log into the platform. The default admin user's login is admin and its password is password.

Licenses

This project is dual-licensed:

• The source code is available under the Apache 2.0 license.
• Art assets (images, audio files) are CC-By-SA 4.0. You should attribute them to Heroic Labs (https://heroiclabs.com/).