GameServer-Reborn

Multi-User Private Server for The Simpsons™: Tapped Out Mobile Game

Getting Started

Prerequisites

To run this server, you'll need Node.js installed. You can download and install it by following the instructions on the official website. Additionally, you will need a patched APK, which the instructions for can be found at TappedOutReborn/Patch-APK.

Installation

Follow these steps to set up the server:

1. Clone the Repository

   Start by cloning the project to your local machine:

   git clone https://github.com/TappedOutReborn/GameServer-Reborn.git

2. Install Dependencies

   Navigate into the project folder and install the required NPM packages:

   cd GameServer-Reborn
   npm install

3. Download DLCs

   The app requires "DLCs", which are game assets like characters, buildings, and quests. These must be added to the server for the game to function.

   • Create a folder called dlc in the server directory (if it doesn't already exist).
   • Download the DLC files using the DLC Downloader.
   • Drag and drop the downloaded DLC files into the dlc folder.

4. Configure Server Settings

   Open the config.json file and update the ip and listenPort values to match your preferred settings:

    "ip": "0.0.0.0",
    "listenPort": 4242

   ip: The IP address or domain that the game client will use to connect to your server (ensure this is accessible by the game). Do NOT use localhost, 127.0.0.1 or 0.0.0.0

   listenPort: The port number the server will listen on.

Running the Server

To start the server, simply run:

npm start

Using the Dashboard(s)

• On the admin dashboard you can configure server settings and the current event, manage users and manage towns. A server configurator is planned.

• On the user dashboard you can make an email account, login and change your username and email, and import and export your town. Adding friends is a planned for the user dashboard.

Admin Dashboard

To access the admin dashboard you'll need the admin key. It will be automaticly generated on server startup if it's not set, and can be found in config.json. To use the admin dashboard simply navigate to:

http://yourip:yourport/dashboard

User Dashboard

To use the user dashboard simply navigate to:

http://yourip:yourport/userdash

Top Contributors:

License

Distributed under the GPLv3 License. See LICENSE for more information.