Skip to content

Commit

Permalink
add the changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Novalis committed Nov 16, 2017
1 parent c9f4a0c commit 6a3dace
Show file tree
Hide file tree
Showing 3 changed files with 147 additions and 3 deletions.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!-- PLEASE READ THE FOLLOWING INSTRUCTIONS -->

<!-- If you are trying to install this on Windows or Mac, screw off. -->

<!--
Make sure it isn't a technical question about your system,
I don't provide individual support.
Unless you're going to pay me.
-->

<!-- Also make sure you've read the README, RTFM. -->

### Description

<!-- Description of the bug, enhancement or question -->

### Steps to Reproduce

<!--
1. First Step
2. Second Step
3. and so on...
-->

### Expected behavior

<!-- What you expected to happen -->

### Actual behavior

<!-- What actually happened -->
30 changes: 30 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [0.0.9] - 2017-11-16
### Added
- server:console -- see the server console
- server:say -- send a message to the console
### Changed README
- Added support
### Fixed
- server:list -- now checks status of server process
- server:create -- shut git the fu*k up
- server:path -- now tells you the path if it is set and a paht isn't provided
- server:stop -- now sends message to server, disablable

## [0.0.8] - 2017-11-15
### Fixed
- Stop Command signature throwing error

## [0.0.7] - 2017-11-15
### Changed
- Storage location for easier updating

## [0.0.4] - 2017-11-15
### Added
- Laravel-Zero
- The initial commands
89 changes: 86 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,89 @@
# FiveM-ServerManager
### Not giving support right now, this is super early alpha. Mostly just here to easily add to my server for testing. I mean come on, I don't even have StyleCI, TravisCI or even tests written at this point. BASICALLY all I'm saying is use at your own risk. Though honestly, even at this stage it does more that any of the others out there for FiveM at the moment.

Server Manager for FiveM
A better FiveM Server Manager

#### How do I install this?

There are two ways to install FSM.

##### Option One

Starting from `0.0.9` and after, in the releases there is an executable file named `fsm`.

You need to download this and put it into one of the locations in your `$PATH`

Also make sure it is marked executable `chmod +x fsm`

###### Requirements
- PHP 7.1
- Linux

##### Option Two

You must have `composer` installed *and its own requirements*

Run the following command:
```
composer global require tnovalis/fivem-servermanager
```

Once you do that you need to add your composer vendor bin to you `$PATH`

On Ubuntu, and most Linux distros this is in `.config/composer/vendor/bin`

If you use Bash for your shell you need to edit `.profile` to add it to your `$PATH`

###### Requirements
- PHP 7.1
- Linux
- The few of composers requirements

#### How do I use this?

The first command you should run is this:
```
fsm fivem:install [<PATH>]
```
This will install FiveM and save the path for when starting the server.

After that I recommend running this:
```
fsm server:path [<PATH>]
```
This will set the server path, making it easier to create servers.

#### What about the other commands?

**To update FiveM**
```
fsm fivem:update
```

**To create a server**
```
fsm server:create [<NAME>] [<PATH>]
```
You don't need to specify the path if the `server:path` is set.

**To list the servers**
```
fsm server:list --path
```
This will display a servers status and also check if a server crashed. You can also use `--path` to see the server's path in the table.

**To send a message to the server**
```
fsm server:say [<NAME>] [<MESSAGE>]
```
The message must be in quotes **unless** you include omit it in the initial command.

**To start a server**
```
fsm server:start [<NAME>]
```

**To stop a server**
```
fsm server:stop [<NAME>]
```

This is written in PHP using Laravel-Zero

0 comments on commit 6a3dace

Please sign in to comment.