Starting Template

Learn more about using the StartingTemplate

Introduction

The starting template provide the easiest way to dive in the Atlas World. This template provide the ability for docker and vanilla. Choose what ever you want.

We don't teach you the installation about docker. Please read the Docker Docs specific for your environment.

Step 1

Install the template with degit. This tool helps you to clone the starter template

npx degit abstractFlo/atlas-starter gamemode

Step 2

Install the dependencies

cd gamemode
npm install

Step 2.1

We love mysql <3, thats why our Docker Template shipped out with a mysql service. You can change this to what ever you want but for fast startup you can use as it is.

If you want using mysql please install the mysql dependency as well.

npm install mysql 

# or

npm install mysql2

Step 3

Set up the required environment variables

Change retail/server.example.cfg folder to retail/server.cfg and .env.example to .env as well.

If you want using docker

Rename docker.compose.example.yml to docker-compose.yml and change this file to fit your needs.

# Describe which branch you want to use for serverfiles only needed if 
# you use docker, otherwise it is ignored
SERVER_BRANCH=rc

# Where to store the builded files
ATLAS_BUILD_OUTPUT=dist

# Clear the build dir before new build is triggered
# only for build not for watch
ATLAS_CLEAR_BEFORE_BUILD=true

# Define which files would be preserve for clean up
# Base server files already preserved
ATLAS_CLEAR_PRESERVE=null

# Path to this project, only needed if you using the docker starter
# Otherwise it is ignored
ATLAS_PROJECT_PATH=.

# Set atlas to production, this means the build files would be minimized
ATLAS_PRODUCTION=true

# Describe the folder where your resources live for building
ATLAS_RESOURCE_FOLDER=resources

# Describe where your static resources live
ATLAS_RETAIL_FOLDER=retail

# Setup your database stuff
DB_CONNECTION=mysql
DB_HOST=altv-mysql
DB_USER=gamemode
DB_PORT=3306
DB_PASS=demo123
DB_DATABASE=gamemode
DB_SYNCRONIZE=true
DB_LOGGING=false

# Setup all variables to your needs to start api-server
DISCORD_API_PORT=null
DISCORD_CLIENT_ID=null
DISCORD_CLIENT_SECRET=null
DISCORD_REDIRECT_URL=http://127.0.0.1:1337

# Setup the discord bot stuff
DISCORD_BOT_SECRET=null
DISCORD_SERVER_ID=null

Step 4

Start the watcher or build and boot up docker. Keep in mind that your terminals need to point to the root directory.

Keep in mind retail folder is only copied at build command. You must be run this command initial.

# If you want to rebuild after changes
npm run watch

# If you want to build the files
npm run build

For docker user

# Inside the second terminal, bootup docker
docker-compose up

# If you want to detach the process
docker-compose up -d

There is no need to stop the docker process everytime. You can stop the server inside the container and restart it at any time you make changes in your script.

Congratulation, you have successfully set up your environment. Now it's time to create your awesome gamemode.

Explain Folder Structure

To help you understand how the whole system works, we will explain the structure and configuration options here. The template contains a good starting point to teach yourself.

There are two folders for your gamemode creation.

Resources

This folder will be bundled by Rollup to ES6 on Server/Client side. Inside the directory you can create folders as many as you want. Your builded resources lives inside ATLAS_BUILD_OUTPUT.

package.json

You can create a package.json file inside your folder. This is only needed one time to tell rollup which folder is a resource and which not.

{
  # the name for your resource
  "name": "gamemode",

  # set true, rollup will bundle it to BUILD_DIR with given name
  "isGameResource": true,

  # Define some externals if you want
  # this is most time not needed
  "external": [],

  # Define all modules they would converted to default import
  # this is most time not needed
  "convert": []

  # Enable if the import should be default or all(*)
  # e.g. import * as module from 'module'
  # default: false
  useStarImport: false;
}

You're done! In most cases there is no need to create multiple gamemode resources. You can create multiple folders inside resources and use them as shared scripts. You can import the scripts at any place inside the resource folder.

- resources
  - gamemode
    - assets
      - resource.cfg
    + server
    + client
    + shared
    - package.json
  - feature_1
    + server
    + client
    + shared
  - feature_2
    + server
    + client
    + shared
  + shared
  ...

Keep in mind, if you set up a package.json, you need the assets folder as well to set up the resource.cfg

Retail

This folder contains all your ready to use resources like maps, cars, weapons and so on. The build process will copy all this files inside your ATLAS_BUILD_OUTPUT and respects your created folder structure inside.

You can prevent some resources for copying by adding an underscore prefix.

+ yourMap // copy to yourMap
+ yourCar // copy to yourCar1
+ yourWeapon // copy to yourWeapon
+ resources/yourMap // copy to resources/yourMap
+ resources/yourCar // copy to resources/yourCar
+ resources/yourWeapon // copy to resources/yourWeapon
+ _notCopied // prevent copy

Using Database

If you want to use the DatabaseService, keep in mind that we don't ship the needed driver. Only TypeORM is shipped. Please install your needed driver as self like mysql.

You can read more about it on TypeORM Documentation inside the Installation section of his docs.

PreviousInstallationNextFAQ

Last updated