Skip to content

Commit

Permalink
readme + version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
tabarra committed Jul 23, 2019
1 parent e7f844e commit ccde7b5
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 32 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,43 +45,43 @@ First, make sure you have:
- One TCP listen port opened for the web server (default is 40120)
- Git (only for installs and updates)

**1 -** In the terminal (cmd, bash, powershell & etc) execute:
**1 -** In the terminal (cmd, bash, powershell & etc) execute the following commands:
```bash
# Download txAdmin, Enter folder and Install dependencies
$ git clone https://github.com/tabarra/txAdmin
$ cd txAdmin
$ npm i
git clone https://github.com/tabarra/txAdmin
cd txAdmin
npm i

# Add admin
$ node src/scripts/admin-add.js
node src/scripts/admin-add.js

# Setup default server profile
$ node src/scripts/setup.js default
node src/scripts/setup.js default

# Start default server
$ node src/index.js default
node src/index.js default
```

**2 -** Then open `http://public-ip:40120/` in your browser and login with the credentials created and go to the settings page to configure the remaining settings.
If on Windows, you can start the server by executing `start.bat` in your server profile's folder (example `data/default/start.bat`).
**If on Windows, you can start txAdmin by executing `start.bat` in your server profile's folder (example `data/default/start.bat`).**

> **Note:** You should run FXServer **through** txAdmin, and not in parallel (ie in another terminal).
> **Note2:** To configure your Discord bot, follow these two guides: [Setting up a bot application](https://discordjs.guide/preparations/setting-up-a-bot-application.html) and [Adding your bot to servers](https://discordjs.guide/preparations/adding-your-bot-to-servers.html).
> **Note3:** Although **not recommended**, you can set FXServer processes priorities. To do so, change `fxRunner.setPriority` to one of the following: LOW, BELOW_NORMAL, NORMAL, ABOVE_NORMAL, HIGH, HIGHEST.
> **Note3:** Although **not recommended**, you can set FXServer processes priorities. To do so, change `fxRunner.setPriority` in the `config.json` to one of the following: LOW, BELOW_NORMAL, NORMAL, ABOVE_NORMAL, HIGH, HIGHEST.
> **Note4:** To create more server profiles, execute `node src/scripts/setup.js <profile name>`.
> **Note4:** To create more server profiles, execute `node src/scripts/setup.js <profile name>`. You can run multiple txAdmin instances in the same installation folder.
## Troubleshooting
### If you run into any problem, check our [Troubleshooting Guide](docs/troubleshooting.md).
If you are having trouble starting the FXServer via txAdmin, run `node src/scripts/config-tester.js default` and see which test is failing.

## Updating
To **UPDATE** txAdmin execute:
To **UPDATE** txAdmin execute the following commands inside txAdmin's folder:
```bash
$ git pull
$ npm i
git pull
npm i
```
If you have any problems with `package-lock.json`, just delete it and try again.
> **Note:** This will only work if you downloaded txAdmin using the `git clone` command.
Expand All @@ -91,7 +91,7 @@ If you have any problems with `package-lock.json`, just delete it and try again.
## TODO:
- [ ] Reorganize all files/folders
- [ ] Write version bumper script
- [ ] Write resource injector
- [x] Write resource injector
- [ ] Add custom commands to the config file
- [x] Config tester check for the modules inside `package.json` (require.resolve?)
- [ ] Config tester kill spawned fxserver after 5 seconds
Expand Down
16 changes: 0 additions & 16 deletions dev_roadmap.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,3 @@
## New Instructions
```bash
# Install
$ git clone https://github.com/tabarra/txAdmin && cd txAdmin
$ npm i

# Add admin
$ node src/scripts/admin-add.js

# Setup default server
$ node src/scripts/setup.js default

# Start default server
$ node src/index.js default
```

## TODO/Roadmap:
> v1.0.5
- [x] adapt admin-add
Expand Down
2 changes: 1 addition & 1 deletion src/components/monitor.js
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ module.exports = class Monitor {
date.setHours(hour);
date.setMinutes(minute - sub);

let remaining = (sub > 1)? `${sub} minutes.` : `${60} seconds. Please disconnect.`;
let remaining = (sub > 1)? `${sub} minutes.` : `60 seconds. Please disconnect.`;
return {
hour: date.getHours(),
minute: date.getMinutes(),
Expand Down
6 changes: 5 additions & 1 deletion version.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "1.7.2",
"version": "1.7.3",
"changelog": "Deprecated Message. Please Update.",
"allVersions": [
{
Expand Down Expand Up @@ -61,6 +61,10 @@
{
"version": "1.7.2",
"changelog": "Fixed commands.resources permission with the wrong name."
},
{
"version": "1.7.3",
"changelog": "Minor bug fixes and improved some settings descriptions and error messages."
}
]
}

0 comments on commit ccde7b5

Please sign in to comment.