Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zeex/samp-server-cli

Control server configuration via command line (without manually editing server.cfg)
https://github.com/zeex/samp-server-cli

cli pip python sa-mp

Last synced: about 2 months ago
JSON representation

Control server configuration via command line (without manually editing server.cfg)

Awesome Lists containing this project

README 

        

samp-server-cli

===============



This is a small Python script that lets you quickly start your SA-MP server 

from the command line without opening, editing, and saving server.cfg every

time you need to change some option. It generates a new server.cfg based on 

the command line arguments you use and optionally starts the server. This can

make it much easier to test various scripts and plugins during development 

(for example, I use it for testing plugins).



Requirements

------------



Python 2.7+ or Python 3.



Usage

-----



You can define the root directory of your SA-MP server installation by 

setting `SAMP_SERVER_ROOT` (see below) and start it from anywhere. If you're

working on a plugin and want to test it, you just do:



```

samp-server-cli -d ./path/to/plugin.so

```



By default `samp-server-cli` uses the "bare" gamemode (`gamemodes/bare.pwn`).

If you want to test some code snippet that you compiled to `somescript.amx`

simply run:



```

samp-server-cli -g ./somescript

```



(the `.amx` part should be omitted)



When you use `./` in front of a file name passed to `-d`, `-g`, or `-f` it

means that it's relative to the current working directory. When you don't,

it means that the path is relative to the corresponding directory (`plugins`,

`gamemodes`, and `filterscripts` respectively).



Installation

------------



Use pip to install a stable version from the Python Package Index:



```sh

sudo pip install samp-server-cli

```



or only for the current user:



```sh

pip install --user samp-server-cli

```



This will create a shell script in your `~/.local/bin` or `/usr/local/bin`

directory on Linux and a .exe file in `C:\PythonXY\Scripts` on Windows.



Alternatively, you can install samp-server-cli by running the accompanying

setup script:



```sh

python setup.py install

```



Finally, you can just download this repository and run samp-server-cli out

of the box using one of the wrapper scripts shipped with the source code.



Post-install configuration

--------------------------



One thing you may need to do after installing samp-server-cli is to set

the `SAMP_SERVER_ROOT` environment variable to the absolute path of your

server's root directory (where samp03svr or samp-server.exe is located).



If you don't do it the script will seach for the server executable file 

in the following locations:



* The current working directory

* The directory in which samp-server-cli is located

* The value of the `SAMP_SERVER_ROOT` variable (if defined)



You can also specify the exact command to start the server using 

`--command` in which case the script will not attempt to find the server

executable.



Examples

--------



How to run a gamemode with default settings:



```

samp-server-cli -g grandlarc

```



How to run a publicly accessible server with maxplayers 10 and RCON

password "test":



```

samp-server-cli -g grandlarc -q -R test -M 10

```



Using filterscripts:



```

samp-server-cli -g grandlarc -f fsdebug -f gl_actions -f gl_realtime

```



Using plugins:



```

samp-server-cli -g grandlarc -d crashdetect -d streamer

```



Adding non-standard server.cfg options:



```

samp-server-cli -g grandlarc -d profiler -x some_option its_value

```



Using existing server.cfg file:



```

samp-server-cli --no-config

```



Reading command line arguments from a file:



```

samp-server-cli @filename

```



Other options

-------------



To see the complete list of command line options run `samp-server-cli -h`.