Skip to content

make instructions on installing it more simple for non-devs #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JadedBlueEyes wants to merge 2 commits into
base: master
Choose a base branch
from
Open

make instructions on installing it more simple for non-devs #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77b883b
make it more simple for non-devs
JadedBlueEyes Aug 1, 2018
2847a45
mentioned terminal
JadedBlueEyes Aug 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,17 @@
This repo provides a way to load the Message Bot with a cross-compatible storage format between the Browser Loader and this loader.

### Setup
1. Clone the repo `git clone https://github.com/Blockheads-Messagebot/Console-Loader.git`
1. Install dependencies `npm install` (or `yarn install`)
1. Build the code `npm run build` (or `yarn build`)
1. Install node from <https://nodejs.org/>
1. Download the repo: ![71af3f2c-eb4b-46f9-93f2-01817d659cb1 min](https://user-images.githubusercontent.com/28905212/43529155-8f6120a4-95a2-11e8-85b4-88536ca61185.gif)
or git clone it: `git clone https://github.com/Blockheads-Messagebot/Console-Loader.git`
1. Install dependencies from your terminal: `npm install` (or `yarn install`)
1. Build the code: `npm run build` (or `yarn build`)
1. Copy the default config file in `./config` to `./config/config.json` and edit with your info
1. Run `npm run worlds` or `npm run worlds:mac` to view a list of worlds and world IDs to use in `config.json`. (`yarn worlds`, `yarn worlds:mac`)
1. Start the bot with `npm run cloud` (`yarn cloud`) (mac not yet complete)

### Custom Extensions

Not yet supported.
Not yet supported.