Skip to content

Commit f2b4cf8

Browse files
committed
Update README.md [ci skip]
1 parent 7e87b73 commit f2b4cf8

File tree

1 file changed

+48
-24
lines changed

1 file changed

+48
-24
lines changed

README.md

Lines changed: 48 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,62 @@
1-
Oxide 2 [![Build Status](https://travis-ci.org/OxideMod/Oxide.png)](https://travis-ci.org/OxideMod/Oxide)
2-
=======
1+
[license]: https://tldrlegal.com/l/mit
2+
[docs]: http://oxidemod.github.io/Docs/
3+
[forums]: http://oxidemod.org/
4+
[issues]: https://github.com/OxideMod/Oxide/issues
5+
[downloads]: http://oxidemod.org/downloads/
36

4-
Oxide 2 is a complete rewrite of the popular, original Oxide mod for the game Rust. Oxide has a focus on modularity and extensibility.
7+
# Oxide Mod [![License](http://img.shields.io/badge/license-MIT-lightgrey.svg?style=flat)][License] [![Build Status](https://travis-ci.org/OxideMod/Oxide.png)](https://travis-ci.org/OxideMod/Oxide)
58

6-
The core is highly abstracted and loosely coupled, and could be used to mod any game that uses .NET such as 7 Days to Die, The Forest, Space Engineers, and more. Support for games, plugin languages, and other functionality is added via extensions. When loading, Oxide 2 scans the binary folder for DLL extensions. Extension filenames are formatted as `Oxide.Ext.Name.dll`.
9+
A complete rewrite of the popular, original Oxide API and Lua plugin framework. Previously only available for the legacy Rust game, Oxide now supports numerous games. Oxide's focus is on modularity and extensibility. The core is highly abstracted and loosely coupled, and could be used to mod any game that uses the .NET Framework.
710

8-
The current official extensions are listed below:
11+
Support for each game and plugin language is added via extensions. When loading, Oxide scans the binary folder for DLL extensions. Extension filenames are formatted as `Oxide.Ext.Name.dll` or `Oxide.Game.Name.dll`.
912

10-
* Oxide.Ext.CSharp - _Allows raw [CSharp plugins](http://en.wikipedia.org/wiki/C_Sharp_(programming_language)) to be loaded_
11-
* Oxide.Ext.JavaScript - _Allows [JavaScript](http://en.wikipedia.org/wiki/JavaScript) plugins to be loaded_
12-
* Oxide.Ext.Lua - _Allows [Lua](http://www.lua.org/) plugins to be loaded_
13+
## Official Core Extensions
14+
15+
* Oxide.Ext.CSharp - _Allows plugins written in [CSharp](http://en.wikipedia.org/wiki/C_Sharp_(programming_language)) to be loaded_
16+
* Oxide.Ext.JavaScript - _Allows plugins written in [JavaScript](http://en.wikipedia.org/wiki/JavaScript) to be loaded_
17+
* Oxide.Ext.Lua - _Allows plugins written in [Lua](http://www.lua.org/) to be loaded_
1318
* Oxide.Ext.MySql - _Allows plugins to access a [MySQL](http://www.mysql.com/) database_
14-
* Oxide.Ext.Python - _Allows [Python](http://en.wikipedia.org/wiki/Python_(programming_language)) plugins to be loaded_
15-
* Oxide.Ext.Rust - _Provides support for the [Rust](http://playrust.com/) Experimental server_
16-
* Oxide.Ext.RustLegacy - _Provides support for the [Rust](http://playrust.com/) Legacy server_
17-
* Oxide.Ext.SevenDays - _Provides support for the [7 Days to Die](http://7daystodie.com/) server_
19+
* Oxide.Ext.Python - _Allows plugins written in [Python](http://en.wikipedia.org/wiki/Python_(programming_language)) to be loaded_
1820
* Oxide.Ext.SQLite - _Allows plugins to access a [SQLite](http://www.sqlite.org/) database_
19-
* Oxide.Ext.Unity - _Provides support for [Unity](http://unity3d.com/) games_
21+
* Oxide.Ext.Unity - _Provides support for [Unity](http://unity3d.com/) powered games_
22+
23+
## Supported Game Extensions
24+
* Oxide.Game.BeastsOfPrey - _Provides support for the [Beasts of Prey](http://www.beastsofprey.com/) server_
25+
* Oxide.Game.ReignOfKings - _Provides support for the [Reign of Kings](http://www.reignofkings.net/) server_
26+
* Oxide.Game.Rust - _Provides support for the [Rust](http://playrust.com/) Experimental server_
27+
* Oxide.Game.RustLegacy - _Provides support for the [Rust](http://playrust.com/) Legacy server_
28+
* Oxide.Game.SevenDays - _Provides support for the [7 Days to Die](http://7daystodie.com/) server_
29+
* Oxide.Game.TheForest - _Provides support for the [The Forest](http://survivetheforest.com/) server_
30+
31+
## Community Extensions
32+
33+
* [Oxide.Ext.RustIO](http://oxidemod.org/extensions/rust-io.768/) - _Provides generation of map images and a live map for Rust_
34+
35+
## Open Source
36+
37+
Oxide is free, open source software distributed under the [MIT License][license]. We accept and encourage contributions from our community, and sometimes give cookies in return.
38+
39+
## Compiling Source
2040

21-
Third-party, unofficial extensions available:
41+
While we recommend using one of the [official release builds][downloads], you can compile your own builds if you'd like. Keep in mind that only official builds are supported by the Oxide team and community.
2242

23-
* [Oxide.Ext.RustIO.dll](http://oxidemod.org/extensions/768/) - _Provides generation of map images, web server, and live map_
43+
1. Clone the git repository locally using `git clone https://github.com/OxideMod/Oxide.git` or download the [latest ZIP](https://github.com/OxideMod/Oxide/archive/master.zip).
44+
2. Open the solution in the latest version of [Visual Studio 2015](https://www.visualstudio.com/en-us/downloads/visual-studio-2015-downloads-vs.aspx), which includes .NET Framework 4.6.
45+
3. Build the project using the solution. If you get errors, you're likely not using the latest Visual Studio 2015.
46+
4. Copy the files from the `Bundles` directory for your game of choice to your server installation.
2447

25-
Examples of what extensions may be available in the future:
48+
## Getting Help
2649

27-
* Oxide.Ext.IRC - _Allows plugins to access an IRC server_
28-
* Oxide.Ext.Updater - _Allows for automatic plugin checking and updating_
50+
* The best place to start with plugin development is the official [API documentation][docs].
51+
* Still need help? Search our [community forums][forums] or create a new thread if needed.
2952

30-
# Compiling Source
53+
## Contributing
3154

32-
While we recommend using one of the [official release builds](http://oxidemod.org/downloads/), you can compile your own builds if you'd like.
55+
* Got an idea or suggestion? Use the [community forums][forums] to share and discuss it.
56+
* Troubleshoot issues you run into on the community forums so everyone can help and reference it later.
57+
* File detailed [issues] on GitHub (version number, what you did, and actual vs expected outcomes).
58+
* Want Oxide and plugins for your favorite game? Hook us up and we'll see what we can do!
3359

34-
1. Clone the git repository locally using `git clone https://github.com/OxideMod/Oxide.git`
35-
2. Open the solution the latest version of [Visual Studio 2015](https://www.visualstudio.com/en-us/downloads/visual-studio-2015-downloads-vs.aspx), which includes .NET Framework 4.6.
36-
3. Build the project using the solution. If you get errors, you're likely not using Visual Studio 2015.
60+
## Reporting Security Issues
3761

38-
Keep in mind that only official builds are supported by the Oxide team and community.
62+
Please disclose security issues responsibly by emailing [email protected] with a full description. We'll work on releasing an updated version as quickly as possible. Please do not email non-security issues; use the [forums] or [issue tracker][issues] instead.

0 commit comments

Comments
 (0)