Rust:Тонкости администрирования сервера uMod или Oxide: различия между версиями
Перейти к навигации
Перейти к поиску
Cucagmin (обсуждение | вклад) |
Cucagmin (обсуждение | вклад) |
||
| Строка 1: | Строка 1: | ||
<ul> | |||
< | <li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"><a href="https://umod.org/documentation/getting-started#installation">Installation</a></span></li> | ||
< | <li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"><a href="https://umod.org/documentation/getting-started#server-requirements">Server requirements</a></span></li> | ||
< | <li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"><a href="https://umod.org/documentation/getting-started#installing-umod">Installing uMod</a></span></li> | ||
< | <li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"><a href="https://umod.org/documentation/getting-started#plugins">Plugins</a></span></li> | ||
< | <li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"><a href="https://umod.org/documentation/getting-started#extensions">Extensions</a></span></li> | ||
< | </ul> | ||
< | <p style="line-height: normal;"><strong><span style="font-size: 24.0pt; font-family: 'Times New Roman',serif;">Getting Started</span></strong></p> | ||
< | <p style="line-height: normal;"><strong><span style="font-size: 18.0pt; font-family: 'Times New Roman',serif;">Installation</span></strong></p> | ||
<p style="line-height: normal;"><strong><span style="font-size: 18.0pt; font-family: 'Times New Roman',serif;">Server requirements</span></strong></p> | |||
<p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">The uMod platform requirements vary depending on the game server.</span></p> | |||
<p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">More information about uMod support for specific games may be found on the <a href="https://umod.org/documentation/umod/game-support">Game Support</a> page.</span></p> | |||
<p style="line-height: normal;"><strong><span style="font-size: 18.0pt; font-family: 'Times New Roman',serif;">Installing uMod</span></strong></p> | |||
. | <p style="line-height: normal;"><strong><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">Via Direct Download</span></strong></p> | ||
<ol> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">Download the uMod version <a href="https://umod.org/games">specific to your game</a>.</span></li> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">Copy the files over your existing server installation</span></li> | |||
</ | |||
< | |||
< | |||
< | |||
</ | |||
</ol> | </ol> | ||
<p style="line-height: normal;"><strong><span style="font-size: 18.0pt; font-family: 'Times New Roman',serif;">Plugins</span></strong></p> | |||
<p | <p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">Plugins are self-contained bits of code which modify game server behavior.</span></p> | ||
line-height:normal; | <p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">For more information about plugins, view the <a href="https://umod.org/documentation/umod/plugins/getting-started">Plugins - Getting Started</a> page.</span></p> | ||
font-family: | <p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"><a href="https://umod.org/plugins">View all available plugins</a></span></p> | ||
<p style="line-height: normal;"><strong><span style="font-size: 18.0pt; font-family: 'Times New Roman',serif;">Extensions</span></strong></p> | |||
<p | <p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">Extensions are generally large projects which add functionality to uMod or make substantial changes to a server.</span></p> | ||
line-height:normal | <p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"><a href="https://umod.org/extensions">View all available extensions</a></span></p> | ||
<p> </p> | |||
<p> </p> | |||
<ul> | |||
<p | <li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"><a href="https://umod.org/documentation/getting-help#searching">Searching</a></span></li> | ||
line-height:normal | <li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"><a href="https://umod.org/documentation/getting-help#plugin-and-extensions">Plugin and extensions</a></span></li> | ||
<li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"><a href="https://umod.org/documentation/getting-help#site-and-platform">Site and platform</a></span></li> | |||
view the <a href="https://umod.org/documentation/umod/plugins/getting-started">Plugins | <li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"><a href="https://umod.org/documentation/getting-help#no-support-guarantee">No support guarantee</a></span></li> | ||
- Getting Started</a> page.</span></p> | |||
<p | |||
line-height:normal | |||
all available plugins</a></span></p> | |||
<p | |||
line-height:normal; | |||
font-family: | |||
<p | |||
line-height:normal | |||
or make substantial changes to a server.</span></p> | |||
<p | |||
line-height:normal | |||
all available extensions</a></span></p> | |||
<ul | |||
</ul> | </ul> | ||
<p style="line-height: normal;"><strong><span style="font-size: 24.0pt; font-family: 'Times New Roman',serif;">Getting Help</span></strong></p> | |||
<p | <p style="line-height: normal;"><strong><span style="font-size: 18.0pt; font-family: 'Times New Roman',serif;">Searching</span></strong></p> | ||
line-height:normal; | <p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">Please search through existing resources before asking for help or creating a new thread.</span></p> | ||
font-family: | <ol> | ||
<li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">Search the <a href="https://umod.org/documentation">documentation</a> provided</span></li> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">Search the <a href="https://umod.org/community/search">forums</a> for answers</span></li> | |||
<p | </ol> | ||
line-height:normal | <p style="line-height: normal;"><strong><span style="font-size: 18.0pt; font-family: 'Times New Roman',serif;">Plugin and extensions</span></strong></p> | ||
<p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">If an issue is undocumented or unreported:</span></p> | |||
<ol> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">Visit the resource page and click the help button.</span></li> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">Create a new thread in that resource's forum category.</span></li> | |||
< | </ol> | ||
<p style="line-height: normal;"><strong><span style="font-size: 18.0pt; font-family: 'Times New Roman',serif;">Site and platform</span></strong></p> | |||
<p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">For general questions or help with the site and/or platform, please use our <a href="https://umod.org/community/35-general-support">General Support</a> forum.</span></p> | |||
<p style="line-height: normal;"><strong><span style="font-size: 18.0pt; font-family: 'Times New Roman',serif;">No support guarantee</span></strong></p> | |||
<p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">The following disclaimer applies to free and open-source plugins/extensions available on umod.org.</span></p> | |||
<p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">This is a community-supported site, which means that support is given at the discretion of others in the community and you are <strong><em>not</em></strong> guaranteed a response.</span></p> | |||
</span></ | <p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">Most free plugins are maintained and supported voluntarily without compensation. Do <strong><em>not</em></strong> expect instant support or free support for open-source resources. Because plugins are open-source, any developer can review the code and potentially answer questions, however that does not mean that every developer is familiar with every plugin.</span></p> | ||
<p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">It can take considerable effort for a developer familiarize themselves with a particular plugin that they did not write. If you want better support from developers, consider donating to them.</span></p> | |||
< | <p> </p> | ||
line-height:normal; | <p> </p> | ||
style= | <p> </p> | ||
" | <p>Плагины</p> | ||
<p> </p> | |||
<ul> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/getting-started#code-files">Code files</a></li> | |||
<p | <li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/getting-started#configuring-a-plugin" data-uid="s75r9Lw6Ul041gXI" data-level="2">Configuring a plugin</a></li> | ||
line-height:normal | <li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/getting-started#plugin-permissions" data-uid="M03Ebp9KVknJldtr" data-level="2">Plugin permissions</a></li> | ||
<li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/getting-started#plugin-commands" data-uid="Iyut0fl9aoWAAawv" data-level="2">Plugin commands</a></li> | |||
</span>< | |||
style= | |||
style= | |||
" | |||
<p | |||
line-height:normal; | |||
font-family: | |||
<p | |||
<p | |||
line-height:normal | |||
style= | |||
style= | |||
" | |||
style= | |||
" | |||
<p | |||
line-height:normal; | |||
< | |||
< | |||
</ul> | </ul> | ||
<h1>Plugins - Getting Started</h1> | |||
< | <p>Plugins are self-contained bits of code which modify game server behavior.</p> | ||
<h2>Code files</h2> | |||
<p>Plugins are code files distributed as CSharp (C#) files and will have a <span style="font-size: 10.0pt;">.cs</span> file extension.</p> | |||
<h3>Installing a code file</h3> | |||
<p>More information about installing plugins may be found at <a href="https://umod.org/documentation/umod/plugins/installation">Plugins - Installation</a>.</p> | |||
<p | <h2>Configuring a plugin</h2> | ||
<p>Many plugins, when installed, will generate a <span style="font-size: 10.0pt;">JSON</span> configuration file with which a server administrator may change how the plugin works.</p> | |||
<p>More information about configuring plugins may be found at <a href="https://umod.org/documentation/umod/plugins/configuration">Plugins - Configuration</a>.</p> | |||
<h2>Plugin permissions</h2> | |||
<p>Many plugins include a variety of permissions which must be assigned in order to use features provided by the plugin.</p> | |||
< | <p>More information about access control may be found at <a href="https://umod.org/documentation/umod/plugins/permissions">Plugins - Permissions</a>.</p> | ||
<h2>Plugin commands</h2> | |||
<p>Many plugins will include commands which may be used by players or server administrators. Not every game will have both types of commands, and by default commands should be available by console and in-game (if applicable).</p> | |||
<h3>Console commands</h3> | |||
< | <p>A console command is a command which is run from..</p> | ||
<ol> | |||
</ | <li style="line-height: normal; tab-stops: list 36.0pt;">In-game console (if game has one)</li> | ||
<li style="line-height: normal; tab-stops: list 36.0pt;">Server application window (if platform supports it)</li> | |||
< | <li style="line-height: normal; tab-stops: list 36.0pt;">RCON console (if game supports RCON)</li> | ||
</ol> | |||
<h3>Chat commands</h3> | |||
<p>Chat commands are run by players who are currently in-game. Console commands are prefixed with a <span style="font-size: 10.0pt;">/</span>.</p> | |||
<p>For example: <span style="font-size: 10.0pt;">/help</span></p> | |||
<p> </p> | |||
<p> </p> | |||
<p> </p> | |||
<ul> | |||
<p | <li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/installation#server-requirements">Server requirements</a></li> | ||
<li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/installation#download-the-source-code" data-uid="FkjEHU9WDJSLrr2g" data-level="2">Download the source code</a></li> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/installation#remote-server" data-uid="wRcsK48SGfv2aSjt" data-level="2">Remote server</a></li> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/installation#plugins-directory" data-uid="AIokEG4ubtGcklqJ" data-level="2">Plugins directory</a></li> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/installation#upload-the-source-code" data-uid="nfVaNlKBkpvw3sqn" data-level="2">Upload the source code</a></li> | |||
style= | <li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/installation#updating" data-uid="30WIMmemeGCJOWqR" data-level="2">Updating</a></li> | ||
<p | |||
< | |||
line-height:normal; | |||
< | |||
line-height:normal; | |||
< | |||
normal;tab-stops: | |||
style= | |||
< | |||
</ul> | </ul> | ||
<h1>Plugin installation</h1> | |||
< | <p>Installing uMod plugins usually only takes a few mouse clicks.</p> | ||
<h2>Server requirements</h2> | |||
<p>To install the plugin on the server, the server provider must support Oxide 2.0 or higher, else the plugins will not load or do anything.</p> | |||
<p>If the server is not online, start it. Then, check that Oxide is fully installed by testing the <span style="font-size: 10.0pt;">oxide.version</span> chat or console command.</p> | |||
<h2>Download the source code</h2> | |||
< | <p>Download a plugin from the <a href="https://umod.org/plugins">plugins page</a>;</p> | ||
<h6>Do <strong><span style="font-family: 'Calibri Light',sans-serif;">not</span></strong> rename the plugin or change the file extension.</h6> | |||
<h2>Remote server</h2> | |||
<p>If the server is not hosted locally, connect to the server via an FTP client. If unsure of the FTP details, please contact the server host.</p> | |||
<h2>Plugins directory</h2> | |||
<p>Find the <span style="font-size: 10.0pt;">plugins</span> folder which is located by default at <span style="font-size: 10.0pt;">oxide/plugins</span> if it has not been changed by the server host</p> | |||
<h2>Upload the source code</h2> | |||
<p | <p>Upload the plugin file into the "plugins" folder and it will be loaded automatically if Oxide is currently installed</p> | ||
<p>Continue to <a href="https://umod.org/documentation/umod/plugins/configuration">configuring the plugin</a>..</p> | |||
<h2>Updating</h2> | |||
<p>If a plugin is already installed and an update is available simply overwrite the original (.cs) file and the new version will be loaded automatically.</p> | |||
<p> </p> | |||
<p> </p> | |||
<p> </p> | |||
<ul> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/configuration#config-directory">Config directory</a></li> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/configuration#file-name" data-uid="xcZeJRrfS871er4W" data-level="2">File name</a></li> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/configuration#valid-json" data-uid="rJ716na1IyKDKhsZ" data-level="2">Valid JSON</a></li> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/configuration#applying-changes" data-uid="iNS5ZZ05JUKjlYrH" data-level="2">Applying changes</a></li> | |||
< | |||
<p | |||
to | |||
< | |||
<p | |||
< | |||
<p | |||
< | |||
<p | |||
< | |||
< | |||
line-height:normal | |||
</ul> | </ul> | ||
<h1>Plugin configuration</h1> | |||
< | <p>Most plugins will generate a JSON configuration file once loaded. With this file, a server owner may change how a plugin works.</p> | ||
<h2>Config directory</h2> | |||
<p>Configuration files are found in the <span style="font-size: 10.0pt;">config</span> folder which is located by default in <span style="font-size: 10.0pt;">oxide/config</span> (unless the server host has moved it).</p> | |||
<h2>File name</h2> | |||
<p>A plugin configuration file will have the same name as the plugin itself.</p> | |||
< | <p>For example, a plugin that is installed as <span style="font-size: 10.0pt;">MyPlugin.cs</span> (if it is configurable) will be accompanied by a JSON file named <span style="font-size: 10.0pt;">MyPlugin.json</span></p> | ||
<h6>Do <strong><span style="font-family: 'Calibri Light',sans-serif;">not</span></strong> rename the configuration file or change the file extension.</h6> | |||
<p>If a plugin is installed but not configurable, no configuration file will be present.</p> | |||
<p>If a plugin is configurable but no configuration file is available, the plugin may be broken; in this case, check the log files under the <span style="font-size: 10.0pt;">oxide/logs</span> directory for errors.</p> | |||
<h2>Valid JSON</h2> | |||
<p>All plugin configuration files are saved as JSON (JavaScript Object Notation). Configuration files <em>must</em> be valid JSON. Use a validator such as <a href="https://jsonlint.com">jsonlint.com</a> to ensure the configuration is valid JSON.</p> | |||
< | <h2>Applying changes</h2> | ||
<p>After making changes to a plugin configuration file, reload the plugin in the server console by using the <span style="font-size: 10.0pt;">oxide.reload</span> command. For example:</p> | |||
<p>oxide.reload MyPlugin</p> | |||
<p> </p> | |||
<p> </p> | |||
<ul> | |||
</span></ | <li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/permissions#players">Players</a></li> | ||
<li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/permissions#groups" data-uid="0wKJ7fRvmvug9qsF" data-level="2">Groups</a></li> | |||
< | <li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/permissions#showing-all-groups-or-permissions" data-uid="727kiZwOcVsDGlIu" data-level="2">Showing all groups or permissions</a></li> | ||
<li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/permissions#using-wildcards" data-uid="5LB3OHFU2AY7mGey" data-level="2">Using wildcards</a></li> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><a href="https://umod.org/documentation/plugins/permissions#conclusion" data-uid="qJh0q4uDYOqoA9VW" data-level="2">Conclusion</a></li> | |||
<p | |||
</ | |||
style= | |||
" | |||
< | |||
line-height:normal; | |||
< | |||
< | |||
style= | |||
" | |||
</ul> | </ul> | ||
<h1>Permissions</h1> | |||
< | <p>Permissions allows server owners to give players unique abilities and benefits on their servers.</p> | ||
<p>Administering permissions is easy; simply enter the desired command and you're done! If your server does not have a console, you can use any compatible RCON tool or remote console to send the commands to the server. Most Oxide/uMod-supported games also support the permission commands in the chat, or will soon.</p> | |||
<p>For this guide, the permission <span style="font-size: 10.0pt;">epicstuff.use</span> will be used as an example. Keep in mind that permissions only exist if provided by a plugin or Oxide/uMod itself.</p> | |||
<p>By default, the groups that are created by Oxide/uMod are: admin and default. These can be changed by editing those under the umod.config.json file. The admin group will automatically be assigned to players that are recognized as admin by the server. The "default" group will automatically be assigned to ALL players that connect to the server.</p> | |||
<h2>Players</h2> | |||
<p | <h3>Grant a permission to an individual player</h3> | ||
<p>oxide.grant player Wulf epicstuff.use</p> | |||
<h3>Revoke a permission from an individual player</h3> | |||
<p>oxide.revoke player Wulf epicstuff.use</p> | |||
<h3>Show a player's permissions</h3> | |||
< | <p>oxide.show player Wulf</p> | ||
<h3>Showing which player or group has a permission</h3> | |||
" | <p>Sometimes this command is helpful when tracking down who has a permission.</p> | ||
<p>oxide.show perm epicstuff.use</p> | |||
< | <h2>Groups</h2> | ||
<h3>Grant a permission to an entire group</h3> | |||
< | <p>oxide.grant group admin epicstuff.use</p> | ||
<h3>Revoke a permission from a group</h3> | |||
< | <p>oxide.revoke group admin epicstuff.use</p> | ||
<h3>Adding a player to an existing group</h3> | |||
<p>Adding a player to a group will give them all of the permissions assigned to that group.</p> | |||
<p>oxide.usergroup add Wulf admin</p> | |||
<h3>Removing a player from an existing group</h3> | |||
<p>Removing a player from a group will remove from them all of the permissions assigned to that group.</p> | |||
<p>oxide.usergroup remove Wulf admin</p> | |||
<h3>Adding an entirely new group</h3> | |||
<p>oxide.group add vipoxide.group add vip VIP 0</p> | |||
<p | <h3>Removing an existing group</h3> | ||
<p>oxide.group remove vip</p> | |||
<h3>Setting the title or rank of a group</h3> | |||
<p>The group title is usually a short description of a group, sometimes used for chat titles. The rank is a number which sorts a group based on its importance.</p> | |||
<p>oxide.group set vip "[VIP Member]"oxide.group set vip "[VIP Member]" 1</p> | |||
<h3>Setting the parent group of another group</h3> | |||
<p>A group will inherit all permissions from its parent group.</p> | |||
<p>oxide.group parent admin default</p> | |||
<h3>Showing a group's members and permissions</h3> | |||
<p>oxide.show group admin</p> | |||
<h2>Showing all groups or permissions</h2> | |||
<p>To show all of the permission groups, simple use the command below.</p> | |||
<p>oxide.show groups</p> | |||
<p>The show all of the registered permissions from plugins and Oxide/uMod, use the command below.</p> | |||
<p>oxide.show perms</p> | |||
<h2>Using wildcards</h2> | |||
<p>A wildcard is something that covers multiple things at once time. For permissions, this is the * symbol. You can use the wildcard (*) to grant multiple permissions at one time. This can be done with all permissions or per plugin based on prefix.</p> | |||
<p>oxide.grant group admin *oxide.grant player Wulf umod.*</p> | |||
<h2>Conclusion</h2> | |||
<p>The same commands are also available with the "o." prefix (ex. "o.grant").</p> | |||
<p>That's the basics to permissions for Oxide/uMod. Permissions give you a fantastic way to manage staff without worrying about them abusing powers from the game's admin functionality (such as flight, noclip, super speed, etc.) so they can still enjoy the game but also help monitor your server at the same time.</p> | |||
<p | <ul> | ||
<li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"><a href="https://umod.org/documentation/plugins/data-files#data-directory">Data directory</a></span></li> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"><a href="https://umod.org/documentation/plugins/data-files#file-names">File names</a></span></li> | |||
<li style="line-height: normal; tab-stops: list 36.0pt;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"><a href="https://umod.org/documentation/plugins/data-files#valid-json">Valid JSON</a></span></li> | |||
<p | |||
line-height:normal; | |||
font-family: | |||
a | |||
< | |||
normal;tab-stops: | |||
style= | |||
</ul> | </ul> | ||
<p style="line-height: normal;"><strong><span style="font-size: 24.0pt; font-family: 'Times New Roman',serif;">Data Files</span></strong></p> | |||
<p | <p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">Data files are </span><span style="font-size: 10.0pt; font-family: 'Courier New';">JSON</span><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"> files that plugins may use to store arbitrary data.</span></p> | ||
line-height:normal; | <p style="line-height: normal;"><strong><span style="font-size: 18.0pt; font-family: 'Times New Roman',serif;">Data directory</span></strong></p> | ||
font-family: | <p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">Data files may be found in the </span><span style="font-size: 10.0pt; font-family: 'Courier New';">data</span><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"> folder which located by default in </span><span style="font-size: 10.0pt; font-family: 'Courier New';">oxide/data</span><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;"> (unless the server host has moved it).</span></p> | ||
<p style="line-height: normal;"><strong><span style="font-size: 18.0pt; font-family: 'Times New Roman',serif;">File names</span></strong></p> | |||
<p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">Data files do not follow any naming convention, a plugin author may specify any name when creating a data file.</span></p> | |||
<p | <p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">It is recommended to plugin authors, when creating a large number of data files, to create them in a subdirectory specific to their plugin.</span></p> | ||
line-height:normal | <p style="line-height: normal;"><strong><span style="font-size: 18.0pt; font-family: 'Times New Roman',serif;">Valid JSON</span></strong></p> | ||
<p style="line-height: normal;"><span style="font-size: 12.0pt; font-family: 'Times New Roman',serif;">All plugin data files are saved as JSON (JavaScript Object Notation). Data files <em>must</em> be valid JSON. If editing a data file manually, use a validator such as <a href="https://jsonlint.com">jsonlint.com</a> to ensure the data file is valid JSON.</span></p> | |||
style= | <p> </p> | ||
style= | |||
<p | |||
line-height:normal; | |||
font-family: | |||
directory</span></ | |||
<p | |||
line-height:normal | |||
style= | |||
style= | |||
" | |||
</span><span style= | |||
server host has moved it).</span></p> | |||
<p | |||
line-height:normal; | |||
font-family: | |||
names</span></ | |||
<p | |||
line-height:normal | |||
creating a data file.</span></p> | |||
<p | |||
line-height:normal | |||
to plugin authors, when creating a large number of data files, to create them | |||
in a subdirectory specific to their plugin.</span></p> | |||
<p | |||
line-height:normal; | |||
font-family: | |||
JSON</span></ | |||
<p | |||
line-height:normal | |||
be valid JSON. If editing a data file manually, use a validator such as <a | |||
href="https://jsonlint.com">jsonlint.com</a> to ensure the data file is valid | |||
JSON.</span></p> | |||
Версия 14:37, 28 января 2019
- <a href="https://umod.org/documentation/getting-started#installation">Installation</a>
- <a href="https://umod.org/documentation/getting-started#server-requirements">Server requirements</a>
- <a href="https://umod.org/documentation/getting-started#installing-umod">Installing uMod</a>
- <a href="https://umod.org/documentation/getting-started#plugins">Plugins</a>
- <a href="https://umod.org/documentation/getting-started#extensions">Extensions</a>
Getting Started
Installation
Server requirements
The uMod platform requirements vary depending on the game server.
More information about uMod support for specific games may be found on the <a href="https://umod.org/documentation/umod/game-support">Game Support</a> page.
Installing uMod
Via Direct Download
- Download the uMod version <a href="https://umod.org/games">specific to your game</a>.
- Copy the files over your existing server installation
Plugins
Plugins are self-contained bits of code which modify game server behavior.
For more information about plugins, view the <a href="https://umod.org/documentation/umod/plugins/getting-started">Plugins - Getting Started</a> page.
<a href="https://umod.org/plugins">View all available plugins</a>
Extensions
Extensions are generally large projects which add functionality to uMod or make substantial changes to a server.
<a href="https://umod.org/extensions">View all available extensions</a>
- <a href="https://umod.org/documentation/getting-help#searching">Searching</a>
- <a href="https://umod.org/documentation/getting-help#plugin-and-extensions">Plugin and extensions</a>
- <a href="https://umod.org/documentation/getting-help#site-and-platform">Site and platform</a>
- <a href="https://umod.org/documentation/getting-help#no-support-guarantee">No support guarantee</a>
Getting Help
Searching
Please search through existing resources before asking for help or creating a new thread.
- Search the <a href="https://umod.org/documentation">documentation</a> provided
- Search the <a href="https://umod.org/community/search">forums</a> for answers
Plugin and extensions
If an issue is undocumented or unreported:
- Visit the resource page and click the help button.
- Create a new thread in that resource's forum category.
Site and platform
For general questions or help with the site and/or platform, please use our <a href="https://umod.org/community/35-general-support">General Support</a> forum.
No support guarantee
The following disclaimer applies to free and open-source plugins/extensions available on umod.org.
This is a community-supported site, which means that support is given at the discretion of others in the community and you are not guaranteed a response.
Most free plugins are maintained and supported voluntarily without compensation. Do not expect instant support or free support for open-source resources. Because plugins are open-source, any developer can review the code and potentially answer questions, however that does not mean that every developer is familiar with every plugin.
It can take considerable effort for a developer familiarize themselves with a particular plugin that they did not write. If you want better support from developers, consider donating to them.
Плагины
- <a href="https://umod.org/documentation/plugins/getting-started#code-files">Code files</a>
- <a href="https://umod.org/documentation/plugins/getting-started#configuring-a-plugin" data-uid="s75r9Lw6Ul041gXI" data-level="2">Configuring a plugin</a>
- <a href="https://umod.org/documentation/plugins/getting-started#plugin-permissions" data-uid="M03Ebp9KVknJldtr" data-level="2">Plugin permissions</a>
- <a href="https://umod.org/documentation/plugins/getting-started#plugin-commands" data-uid="Iyut0fl9aoWAAawv" data-level="2">Plugin commands</a>
Plugins - Getting Started
Plugins are self-contained bits of code which modify game server behavior.
Code files
Plugins are code files distributed as CSharp (C#) files and will have a .cs file extension.
Installing a code file
More information about installing plugins may be found at <a href="https://umod.org/documentation/umod/plugins/installation">Plugins - Installation</a>.
Configuring a plugin
Many plugins, when installed, will generate a JSON configuration file with which a server administrator may change how the plugin works.
More information about configuring plugins may be found at <a href="https://umod.org/documentation/umod/plugins/configuration">Plugins - Configuration</a>.
Plugin permissions
Many plugins include a variety of permissions which must be assigned in order to use features provided by the plugin.
More information about access control may be found at <a href="https://umod.org/documentation/umod/plugins/permissions">Plugins - Permissions</a>.
Plugin commands
Many plugins will include commands which may be used by players or server administrators. Not every game will have both types of commands, and by default commands should be available by console and in-game (if applicable).
Console commands
A console command is a command which is run from..
- In-game console (if game has one)
- Server application window (if platform supports it)
- RCON console (if game supports RCON)
Chat commands
Chat commands are run by players who are currently in-game. Console commands are prefixed with a /.
For example: /help
- <a href="https://umod.org/documentation/plugins/installation#server-requirements">Server requirements</a>
- <a href="https://umod.org/documentation/plugins/installation#download-the-source-code" data-uid="FkjEHU9WDJSLrr2g" data-level="2">Download the source code</a>
- <a href="https://umod.org/documentation/plugins/installation#remote-server" data-uid="wRcsK48SGfv2aSjt" data-level="2">Remote server</a>
- <a href="https://umod.org/documentation/plugins/installation#plugins-directory" data-uid="AIokEG4ubtGcklqJ" data-level="2">Plugins directory</a>
- <a href="https://umod.org/documentation/plugins/installation#upload-the-source-code" data-uid="nfVaNlKBkpvw3sqn" data-level="2">Upload the source code</a>
- <a href="https://umod.org/documentation/plugins/installation#updating" data-uid="30WIMmemeGCJOWqR" data-level="2">Updating</a>
Plugin installation
Installing uMod plugins usually only takes a few mouse clicks.
Server requirements
To install the plugin on the server, the server provider must support Oxide 2.0 or higher, else the plugins will not load or do anything.
If the server is not online, start it. Then, check that Oxide is fully installed by testing the oxide.version chat or console command.
Download the source code
Download a plugin from the <a href="https://umod.org/plugins">plugins page</a>;
Do not rename the plugin or change the file extension.
Remote server
If the server is not hosted locally, connect to the server via an FTP client. If unsure of the FTP details, please contact the server host.
Plugins directory
Find the plugins folder which is located by default at oxide/plugins if it has not been changed by the server host
Upload the source code
Upload the plugin file into the "plugins" folder and it will be loaded automatically if Oxide is currently installed
Continue to <a href="https://umod.org/documentation/umod/plugins/configuration">configuring the plugin</a>..
Updating
If a plugin is already installed and an update is available simply overwrite the original (.cs) file and the new version will be loaded automatically.
- <a href="https://umod.org/documentation/plugins/configuration#config-directory">Config directory</a>
- <a href="https://umod.org/documentation/plugins/configuration#file-name" data-uid="xcZeJRrfS871er4W" data-level="2">File name</a>
- <a href="https://umod.org/documentation/plugins/configuration#valid-json" data-uid="rJ716na1IyKDKhsZ" data-level="2">Valid JSON</a>
- <a href="https://umod.org/documentation/plugins/configuration#applying-changes" data-uid="iNS5ZZ05JUKjlYrH" data-level="2">Applying changes</a>
Plugin configuration
Most plugins will generate a JSON configuration file once loaded. With this file, a server owner may change how a plugin works.
Config directory
Configuration files are found in the config folder which is located by default in oxide/config (unless the server host has moved it).
File name
A plugin configuration file will have the same name as the plugin itself.
For example, a plugin that is installed as MyPlugin.cs (if it is configurable) will be accompanied by a JSON file named MyPlugin.json
Do not rename the configuration file or change the file extension.
If a plugin is installed but not configurable, no configuration file will be present.
If a plugin is configurable but no configuration file is available, the plugin may be broken; in this case, check the log files under the oxide/logs directory for errors.
Valid JSON
All plugin configuration files are saved as JSON (JavaScript Object Notation). Configuration files must be valid JSON. Use a validator such as <a href="https://jsonlint.com">jsonlint.com</a> to ensure the configuration is valid JSON.
Applying changes
After making changes to a plugin configuration file, reload the plugin in the server console by using the oxide.reload command. For example:
oxide.reload MyPlugin
- <a href="https://umod.org/documentation/plugins/permissions#players">Players</a>
- <a href="https://umod.org/documentation/plugins/permissions#groups" data-uid="0wKJ7fRvmvug9qsF" data-level="2">Groups</a>
- <a href="https://umod.org/documentation/plugins/permissions#showing-all-groups-or-permissions" data-uid="727kiZwOcVsDGlIu" data-level="2">Showing all groups or permissions</a>
- <a href="https://umod.org/documentation/plugins/permissions#using-wildcards" data-uid="5LB3OHFU2AY7mGey" data-level="2">Using wildcards</a>
- <a href="https://umod.org/documentation/plugins/permissions#conclusion" data-uid="qJh0q4uDYOqoA9VW" data-level="2">Conclusion</a>
Permissions
Permissions allows server owners to give players unique abilities and benefits on their servers.
Administering permissions is easy; simply enter the desired command and you're done! If your server does not have a console, you can use any compatible RCON tool or remote console to send the commands to the server. Most Oxide/uMod-supported games also support the permission commands in the chat, or will soon.
For this guide, the permission epicstuff.use will be used as an example. Keep in mind that permissions only exist if provided by a plugin or Oxide/uMod itself.
By default, the groups that are created by Oxide/uMod are: admin and default. These can be changed by editing those under the umod.config.json file. The admin group will automatically be assigned to players that are recognized as admin by the server. The "default" group will automatically be assigned to ALL players that connect to the server.
Players
Grant a permission to an individual player
oxide.grant player Wulf epicstuff.use
Revoke a permission from an individual player
oxide.revoke player Wulf epicstuff.use
Show a player's permissions
oxide.show player Wulf
Showing which player or group has a permission
Sometimes this command is helpful when tracking down who has a permission.
oxide.show perm epicstuff.use
Groups
Grant a permission to an entire group
oxide.grant group admin epicstuff.use
Revoke a permission from a group
oxide.revoke group admin epicstuff.use
Adding a player to an existing group
Adding a player to a group will give them all of the permissions assigned to that group.
oxide.usergroup add Wulf admin
Removing a player from an existing group
Removing a player from a group will remove from them all of the permissions assigned to that group.
oxide.usergroup remove Wulf admin
Adding an entirely new group
oxide.group add vipoxide.group add vip VIP 0
Removing an existing group
oxide.group remove vip
Setting the title or rank of a group
The group title is usually a short description of a group, sometimes used for chat titles. The rank is a number which sorts a group based on its importance.
oxide.group set vip "[VIP Member]"oxide.group set vip "[VIP Member]" 1
Setting the parent group of another group
A group will inherit all permissions from its parent group.
oxide.group parent admin default
Showing a group's members and permissions
oxide.show group admin
Showing all groups or permissions
To show all of the permission groups, simple use the command below.
oxide.show groups
The show all of the registered permissions from plugins and Oxide/uMod, use the command below.
oxide.show perms
Using wildcards
A wildcard is something that covers multiple things at once time. For permissions, this is the * symbol. You can use the wildcard (*) to grant multiple permissions at one time. This can be done with all permissions or per plugin based on prefix.
oxide.grant group admin *oxide.grant player Wulf umod.*
Conclusion
The same commands are also available with the "o." prefix (ex. "o.grant").
That's the basics to permissions for Oxide/uMod. Permissions give you a fantastic way to manage staff without worrying about them abusing powers from the game's admin functionality (such as flight, noclip, super speed, etc.) so they can still enjoy the game but also help monitor your server at the same time.
- <a href="https://umod.org/documentation/plugins/data-files#data-directory">Data directory</a>
- <a href="https://umod.org/documentation/plugins/data-files#file-names">File names</a>
- <a href="https://umod.org/documentation/plugins/data-files#valid-json">Valid JSON</a>
Data Files
Data files are JSON files that plugins may use to store arbitrary data.
Data directory
Data files may be found in the data folder which located by default in oxide/data (unless the server host has moved it).
File names
Data files do not follow any naming convention, a plugin author may specify any name when creating a data file.
It is recommended to plugin authors, when creating a large number of data files, to create them in a subdirectory specific to their plugin.
Valid JSON
All plugin data files are saved as JSON (JavaScript Object Notation). Data files must be valid JSON. If editing a data file manually, use a validator such as <a href="https://jsonlint.com">jsonlint.com</a> to ensure the data file is valid JSON.