Ratstail91/SANCTUM
1
0
Fork 0
mirror of https://github.com/Ratstail91/SANCTUM.git synced 2025-11-29 02:24:27 +11:00
Code Issues Packages Projects Releases Wiki Activity

HARD FORK: slashed and burned everything that isn't immedately needed or working

Browse Source
This commit is contained in:
Kayne Ruse
2018-10-28 19:35:41 +11:00
parent 3a2d5dc2fb
commit ba4316ef3d
49 changed files with 30 additions and 10848 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@@ -1,57 +1,11 @@
# ![SANCTUM Logo](https://i.imgur.com/yZI3Am9.png) SANCTUM
[![SANCTUM Discord](https://img.shields.io/badge/sanctum-discord-%237289DA.svg?logo=discord)](https://discord.gg/D7dyrVn)
[![SANCTUM Developers](https://img.shields.io/badge/sanctum-developers-%237289DA.svg?logo=discord)](https://discord.gg/mP98ZYv)
# What is SANCTUM?
SANCTUM is an open-source Discord MMO, with 200+ players.
- [Discord Game Invite Link](https://discord.gg/D7dyrVn)
- [Developer's Discord](https://discord.gg/mP98ZYv)
[![SANCTUM Discord](https://img.shields.io/badge/sanctum-discord-%237289DA.svg?logo=discord)](https://discord.gg/uUEQVwt)
# Run the Bots
## Requirements:
You will need:
- [Node.js](https://nodejs.org/en/) (recommended v8.12.0 LTS)
This is a hard-fork of SANCTUM by Tim Ruswick and the Game Dev Underground crew. For a rough guide on how to install and run this software, it's recommended that you refer to the original REAMDE.md in the original branch:
## Steps
1. Clone the repo.
[TimRuswick/SANCTUM](https://github.com/TimRuswick/SANCTUM)
You can use programs like [Git](https://git-scm.com/), [SourceTree](https://www.sourcetreeapp.com/) or simply download the project, although you won't be able to submit changes as easily.
TODO: A more official guide is coming soon.
```bash
git clone https://github.com/TimRuswick/SANCTUM
```
2. Rename the `.envdev` file to `.env`, and fill out tokens and channels.
Make sure you save it, and also don't push any of your tokens here! If you do though, consider them compromised and then reset them. On Windows, you must give the .env file a name, but you can circumvent it by using a program like [VS Code](https://code.visualstudio.com/) to rename files!
3. Navigate via command-line to a bot's folder, install dependencies, and run it!
Make sure you're in the project folder!
On Windows, you can hold Shift and Right Click the folder to get the option of a command prompt, inside that folder.
```bash
cd "SANCTUM" # Navigate to project folder
npm i # For modules dependencies
cd "A.D.A.M." # Choose a bot
npm i # Install dependencies
node adam.js # Run the bot
```
4. ???
5. Profit! You did it, unless something has happened along the way. ~~Developer luck says yes.~~
## Quality of Life
We recommend [nodemon](https://nodemon.io/) for reloading bots automatically, instead of `Ctrl+C`ing in and out of bots when you need a restart.
# Join the SANCTUM Development Team
We're looking for:
- Discord.js programmers
- Artists
- Writers
- Designers
- Producers
- and Testers!
Join the [SANCTUM Developers](https://discord.gg/mP98ZYv) Discord for more info!