Skip to content

Commit

Permalink
Additional Info
Browse files Browse the repository at this point in the history
  • Loading branch information
Stuyk committed Jan 5, 2020
1 parent 11f447a commit 5196d6d
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 10 deletions.
32 changes: 24 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,26 @@ cd altv-quickstart
```

2. Run the code block below this.
5.1. This can be used whenever you need to update your server files.
5.2. Run the code block below; wait for packages to install.
5.2. Then follow the instructions on screen.

5.1. This can be used whenever you need to update your server files.

5.2. Run the code block below; wait for packages to install.

5.2. Then follow the instructions on screen.

```
npm run update
```

3. Bootup the Server
3.1. This script downloads for Linux or Windows automatically.
3.2. Use a screen on Linux to run the server in the background.
3.3. Use a built in command prompt such as in VSCode to run the server.
3.4. You may press `Ctrl + C` to stop the server at any time.

3.1. This script downloads for Linux or Windows automatically.

3.2. Use a screen on Linux to run the server in the background.

3.3. Use a built in command prompt such as in VSCode to run the server.

3.4. You may press `Ctrl + C` to stop the server at any time.

Linux:

Expand All @@ -48,6 +55,14 @@ Windows (Powershell):
./altv-server.exe
```

### Recommend VSCode Plugins

- [alt:V Auto Complete for VSCode](https://marketplace.visualstudio.com/items?itemName=stuyk.atlv-complete)

- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)

- [Bracket Pair Colorizer](https://marketplace.visualstudio.com/items?itemName=CoenraadS.bracket-pair-colorizer)

### Useful Links

- [alt:V Getting Started Guide](https://wiki.altv.mp/Tutorial_Getting_Started)
Expand Down Expand Up @@ -77,7 +92,8 @@ npm i -D @altv/native-types
```

2. Replace current imports with these special imports.
2.1 For Server:

2.1 For Server:

```
/// <reference types="@altv/types" />
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "altv-orp",
"name": "altv-quickstart",
"version": "0.0.1",
"description": "An open source roleplay project for alt:V",
"description": "A Quick Start Project for alt:V",
"main": "index.js",
"scripts": {
"update": "npm install && node ./install.js"
Expand Down

0 comments on commit 5196d6d

Please sign in to comment.