themaster1970sf/TShock
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

∆: update readme with exp download docs

Browse source
This commit is contained in:
Lucas Nicodemus 2020-02-09 21:44:47 -08:00
parent 64b2e532be
commit 11d2d63c20
No known key found for this signature in database
GPG key ID: A07BD9023D1664DB
1 changed files with 12 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -5,7 +5,7 @@
TShock is a toolbox for Terraria servers and communities. That toolbox is jam packed with anti-cheat tools, server-side characters, groups, permissions, item bans, tons of commands, and limitless potential. It's one of a kind. TShock is a toolbox for Terraria servers and communities. That toolbox is jam packed with anti-cheat tools, server-side characters, groups, permissions, item bans, tons of commands, and limitless potential. It's one of a kind.
* Download: [Stable](https://github.com/TShock/TShock/releases) or [Experimental](https://travis.tshock.co/). * Download: [Stable](https://github.com/TShock/TShock/releases) or [Experimental](#experimental-downloads).
* Read [the documentation](https://tshock.readme.io/) to quickly get up to speed. * Read [the documentation](https://tshock.readme.io/) to quickly get up to speed.
* Join [Discord](https://discord.gg/Cav9nYX) for quick questions and answers * Join [Discord](https://discord.gg/Cav9nYX) for quick questions and answers
* Join [Telegram](https://t.me/pryaxis) for in-depth support, conversation, and some swell Australian company. * Join [Telegram](https://t.me/pryaxis) for in-depth support, conversation, and some swell Australian company.
@ -16,6 +16,7 @@ TShock is a toolbox for Terraria servers and communities. That toolbox is jam pa
## Table of Contents ## Table of Contents
* [New to TShock?](#new-to-tshock) * [New to TShock?](#new-to-tshock)
* [Experimental Downloads](#experimental-downloads)
* [Developer's Guide](#developers-guide) * [Developer's Guide](#developers-guide)
* [Background](#background) * [Background](#background)
* [Building](#building) * [Building](#building)
@ -64,6 +65,16 @@ _These instructions assume Windows. If you're setting up on Linux or macOS, plea
1. You can now [customize your configuration](https://tshock.readme.io/docs/config-settings), build groups, ban items, and install more plugins. 1. You can now [customize your configuration](https://tshock.readme.io/docs/config-settings), build groups, ban items, and install more plugins.
## Experimental Downloads
To download experimental versions of TShock, you have two real options: AppVeyor builds or GitHub builds. You can also get archived Travis CI builds. Fair warning though: experimental versions of TShock are point-in-time releases that are not technically supported by us. If you have to report an issue, please make it clear which commit or branch you downloaded your build from, which service, and the build number if applicable.
On [AppVeyor](https://ci.appveyor.com/project/hakusaro/tshock/), click on history, find the build you want, click on the commit message, and then click on the artifacts tab. You can download either the debug or the release build. AppVeyor only keeps builds back 6 months though.
On [GitHub](https://github.com/Pryaxis/TShock/), click on the actions tab, then click on "build server" on the commit or branch you want. If it was successful, you can download "TShockRelease" under the artifacts section to get that build artifact.
For old builds from Travis CI, you can still get them (for now) from us directly, on [our Travis CI artifact mirror](https://travis.tshock.co/). Please note that these builds should be considered legacy and for archival purposes only. If you need them in the long term, please raise an issue explaining why before they are removed.
## Developer's Guide ## Developer's Guide
Whether you want to contribute to TShock by sending a pull request, customize it to suit your own elvish desires, or want to build your own plugin, this is the best starting point. By the end of this, you'll be able to build TShock from source, start to finish. More than that, though, you'll know how to start on the path of becoming an expert TShock developer. Whether you want to contribute to TShock by sending a pull request, customize it to suit your own elvish desires, or want to build your own plugin, this is the best starting point. By the end of this, you'll be able to build TShock from source, start to finish. More than that, though, you'll know how to start on the path of becoming an expert TShock developer.