Server Creation Guide

Introduction

Stellar Bit is a community-driven game that empowers players to create their own servers with customized objectives and features. Hosting your own server allows you to define unique gameplay experiences, set custom rules, and build a community around your vision of the game.

This guide will walk you through the process of creating both public and private servers in Stellar Bit. Whether you want to host a server accessible to all players or set up a private playground for a select group, this tutorial has you covered.

Types of Servers

There are two types of servers you can create in Stellar Bit:

1. Public Servers: Accessible by anyone with an official Stellar Bit account. These servers are listed on the Stellar Bit Central Hub and can incorporate authentication and authorization features.

2. Private Servers: Not listed publicly and do not require authentication. Ideal for small groups or testing purposes.

Creating a Public Server

Prerequisites

• Official Stellar Bit Account: You need an account to host a public server. If you don't have one, you can create it for free at stellar-bit.com.

Steps to Create a Public Server

1. Registering Your Server

1. Log In to Your Account

   • Visit stellar-bit.com and log in with your credentials.

2. Navigate to 'My Servers'

   • Once logged in, go to the My Servers section.

3. Create a New Server Entry

   • Click the plus (+) button located at the bottom right corner of the page.
   • Fill in the Server Name and Description to suit your server's theme or objectives.
   • Save your new server entry.

   Note: At this point, your server is registered but not yet online.

2. Setting Up the Server Software

To make your server operational, you need to run the server software and keep it connected to the Stellar Bit Central Hub.

Using the Server Template with Authentication

A pre-built template is available to simplify the process:

• Template Repository: stellar-bit/server-template-auth

Steps:

1. Download the Template

   • Clone or download the repository to your local machine:

     git clone https://github.com/stellar-bit/server-template-auth.git
     

2. Open the Template in Your Code Editor

   • Navigate to the downloaded folder and open it in your preferred code editor (e.g., VSCode, Atom).

3. Configure Server Settings

   • Open the src/lib.rs file.
   • Locate the constants SERVER_ADDR and SERVER_NAME.
     • SERVER_ADDR: Set this to your server's public IP address and port (e.g., "0.0.0.0:12345").
     • SERVER_NAME: Ensure this matches the name you registered on the Stellar Bit website.

4. Compile and Run the Server

   • Open a terminal in the project directory.

   • Run the following command to compile and start the server:

     cargo run --release
     

5. Authenticate Your Server

   • When prompted, enter your Stellar Bit account credentials. This step connects your server to the Central Hub and allows it to appear in the public server list.

6. Keep the Server Running

   • Ensure the server application remains running. It sends keep-alive packets to the Central Hub every 5 minutes to maintain its online status.

3. Testing Your Server

• Connect Using the Stellar Bit Client

  • Open the client application.
  • Connect to the Central Hub to see your server listed.
  • Join your server to test connectivity and functionality.

Creating a Private Server

Creating a private server is similar to a public server but without the need for an official Stellar Bit account or authentication.

Steps to Create a Private Server

1. Setting Up the Server Software

Using the Private Server Template

• Template Repository: stellar-bit/server-template

Steps:

1. Download the Template

   • Clone or download the repository to your local machine:

     git clone https://github.com/stellar-bit/server-template.git
     

2. Open the Template in Your Code Editor

   • Navigate to the downloaded folder and open it in your preferred code editor.

3. Configure Server Settings

   • Open the src/lib.rs file.
   • Locate the constant SERVER_ADDR.
     • SERVER_ADDR: Set this to your server's public or local IP address and port (e.g., "0.0.0.0:12345").

4. Compile and Run the Server

   • Open a terminal in the project directory.

   • Run the following command to compile and start the server:

     cargo run --release
     

   Note: Since this is a private server, you won't need to enter any credentials.

2. Sharing Your Server

• Distribute Your IP Address

  • Share your server's IP address and port with the players you want to invite.
  • They can connect directly through the Network Connection window in the client application.

3. Testing Your Server

• Connect Using the Stellar Bit Client

  • Open the client application.
  • Use the Network Connection window to enter your server's IP address and port.
  • Join your server to test connectivity and functionality.

Customizing Server Logic

Creating your own server isn't just about hosting; it's also about crafting unique gameplay experiences. You can modify the server logic to introduce new features, rules, and objectives.

Exploring Server Logic

• Official FFA Server Source Code

  • For inspiration and reference, check out the source code of the official Free-For-All (FFA) server:

    • Repository: stellar-bit/ffa-server

Steps to Customize Your Server

1. Understand the Existing Code

   • Review the code in the server template you downloaded.
   • Familiarize yourself with the structure and functions.

2. Plan Your Changes

   • Decide what features or rules you want to implement.
   • Consider how these changes will affect gameplay.

3. Modify the Code

   • Use your code editor to implement your changes.
   • Update functions, add new modules, or adjust parameters as needed.

4. Test Thoroughly

   • After making changes, recompile and run your server:

     cargo run --release
     

   • Connect with a client to test the new features.

   • Invite others to help test and provide feedback.

5. Iterate

   • Based on testing, make further adjustments.
   • Ensure stability and a positive user experience.

Tips for Customization

• Backup Regularly

  • Keep backups of working versions before making significant changes.

• Use Version Control

  • Consider using Git to track changes and collaborate with others.

• Community Resources

  • Engage with the Stellar Bit community for support and ideas.
  • Share your server and learn from other server creators.

Additional Information

Keep-Alive Packets

• Purpose

  • The server sends keep-alive packets to the Stellar Bit Central Hub every 5 minutes to indicate it's online and available.

• For Public Servers

  • Essential for maintaining your server's listing on the Central Hub.

• For Private Servers

  • Not necessary since they aren't listed on the Central Hub.

Networking Considerations

• Firewall Settings

  • Ensure your server's port is open and accessible through your firewall.

• Port Forwarding

  • If hosting from a private network, you may need to set up port forwarding on your router.

• Static IP Address

  • A static IP or dynamic DNS service can help players consistently connect to your server.

Conclusion

Hosting your own Stellar Bit server opens up a universe of possibilities. Whether you're aiming to build a massive multiplayer arena or a private sandbox for friends, this guide provides the foundation to get you started.

Remember:

• Public Servers connect you with the broader Stellar Bit community.
• Private Servers give you control over who joins and how the game is played.
• Custom Server Logic allows you to create unique experiences.

Support and Community

• Official Website: stellar-bit.com
• Community Forums: Join discussions, ask questions, and share your server.
• GitHub Repositories: Access templates and source code for further customization.

Happy hosting, and may your server bring new adventures to the Stellar Bit universe!