icedream
/
icecon
mirror of https://github.com/icedream/icecon.git
1
0
Fork 0
Code Issues Releases Wiki Activity
icecon/README.md

42 lines
2.7 KiB
Markdown
Raw Normal View History

Add logo and screenshots to README.md.
2016-05-07 16:30:54 +00:00
# ![Logo](img/logo_32.png) IceCon RCON client
Initial commit.
2016-05-05 20:39:46 +00:00
Remove Jenkins badge. We no longer use Jenkins to continuously build and release this app.
2022-04-09 14:40:36 +00:00
[![Release version](https://img.shields.io/github/release/icedream/icecon.svg?maxAge=2592000)](https://github.com/icedream/icecon/releases)
![Maintained?](https://img.shields.io/maintenance/yes/2022.svg?maxAge=2592000)
Badges!
2016-05-07 16:40:10 +00:00
Initial commit.
2016-05-05 20:39:46 +00:00
*IceCon* is a Q3-compatible RCON client. It can connect to any server that implements RCON over a Q3-compatible network protocol (UDP) and even comes with a nice, straight minimal GUI.
Add reference to FiveM post.
2022-04-10 01:42:56 +00:00
Specifically, this tool has been written for quick administration of modified Modern Warfare 2 ("IW4M") servers but it [is also officially supported for use with FiveM servers](https://forum.cfx.re/t/release-icecon-the-officially-supported-rcon-tool/7558).
A Windows user could easily set up shortcuts on the desktop that run `icecon.exe -gui <server:port> <password>` which gives you an instant GUI to run commands on your server. Another use case would be scripting on a Linux server by running `icecon -command "<your command here>" <server:port> <password>` to automate specific tasks.
Initial commit.
2016-05-05 20:39:46 +00:00
Add logo and screenshots to README.md.
2016-05-07 16:30:54 +00:00
![Screenshot 1](img/screenshot1.png)
![Screenshot 2](img/screenshot2.png)
![Screenshot 3](img/screenshot3.png)
Initial commit.
2016-05-05 20:39:46 +00:00
## Download
### Binaries
Add reference to releases page for binaries.
2016-05-07 14:22:17 +00:00
Binaries for all releases for Linux and Windows are always available on the [GitHub releases page](https://github.com/icedream/icecon/releases).
Initial commit.
2016-05-05 20:39:46 +00:00
### Source code
You can download the source code from GitHub, either via Git (`git clone https://github.com/icedream/icecon.git`) or as a source code archive via the "Download ZIP"/"Download TAR.GZ" button at the top right of the [GitHub project page](https://github.com/icedream/icecon).
## Compiling from source code
In most cases, simply installing [Go 1.6 or newer](http://golang.org) and running `go build -i -v .` will give you a single binary that contains everything you need to run *IceCon*.
If you need to regenerate the UI code files (`*_ui.go`) and/or the Windows resource data (`rsrc_windows.syso`), make sure to follow these steps:
- Set up a `GOPATH` as environment variable that points to an existing folder. This folder will be used by Go to store compiled libraries and installed binaries which will be needed for the next step.
- Ensure you have `$GOPATH/bin` (`%GOPATH%\bin` on Windows) included in your `PATH` environment variable.
Use custom fork of ui2walk for cross-compile support.
2016-05-06 18:40:53 +00:00
- Install needed tools and dependencies via `go get -v -u github.com/icedream/ui2walk github.com/josephspurrier/goversioninfo/cmd/goversioninfo`.
Initial commit.
2016-05-05 20:39:46 +00:00
- Run `go generate -v` in the *IceCon* source code folder.
You should now be able to run a normal `go build` to get your desired binary.
## License
This project is licensed under the **GNU General Public License Version 2 or any later version**. For more info, see the [COPYING](COPYING) text file.