Ensure that you have followed and completed the 'Before Setup' instructions page. The prerequisites inside of that page are deeply important to making alt:V Athena function out of the box.
If you have NOT DONE this please select your operating system:
Thanks to the wonders of Node, and GIT. Installing Athena is incredibly easy and the instructions are mostly the same across all operating systems.
You are going to need to open a terminal, command line, or powershell. If you are on Linux make sure you have SSH Access and have gained root access to your server.
You are going to want to clone the main repository.
git clone https://github.com/Stuyk/altv-athena.git
This is just a fancy way of saying. Go into the
Keep in mind that all the commands below need to be ran inside of the
altv-athena folder where your
package.json is located. This is super important.
This downloads all of our other repository dependencies such as the Ares Authorization Service.
git submodule update --init --recursive --force --remote
This installs all NodeJS packages and dependencies that help run the server.
From this point forward you can simply run this
npm command to update dependencies.
npm run update
The license key is unique to your Gumroad Transaction. The license key will allow you to properly boot the alt:V Athena Server. This can be installed by using Environment Variables or a simple
.env file will do.
In the same directory as your
package.json file. Create a file called
.env and open it up in whatever text editor you like to use. If you're on Linux try
nano and make sure to lookup the hotkeys for nano.
Add the following lines to your
.env file depending on what you need.
Note: Anything marked with * is optional.
This argument is for your alt:V Athena Subscription License. It lets you boot the script.
This argument is for your Gumroad Email. The Email you used when you bought a license.
This argument is if you went with a remote MongoDB Server.
This argument is if your database has a username anbd password. Highly recommended if you have remote access.
This argument is if your databae has a username and password. Highly recommended if you have remote access.
Results May Vary
You should end up with something similar to this.
Do not put parameters if they are empty. You may not get the desired effect you want.
That's it! You're ready to begin using your server.
Running the server is done through
npm commands since we need to compile some code before we boot up the server. Run the following commands based on your system.
npm run linux
npm run windows
Running the server in development mode allows for faster compilation and restarts.
This will automatically copy all new file changes and only compile typescript changes.
Highly recommended to use this when modifying the server and performing tests.
npm run watch-windows
npm run watch-linux