Inštalácia pluginov na Rust server (Oxide aj Carbon)

Plugin pre Rust je jeden súbor s príponou .cs. Nahráte ho do správneho priečinka a framework ho sám načíta, bez reštartu servera. Ukážeme, kde pluginy hľadať, ako ich nainštalovať, nastaviť, preložiť, aktualizovať a odobrať a čo robiť, keď sa nenačítajú.

Ako pluginy fungujú#

• Plugin je zdrojový kód v C#. Framework stráži priečinok s pluginmi a nový alebo zmenený súbor sám preloží a načíta. Server kvôli tomu nemusíte reštartovať.
• Pri prvom načítaní si plugin obvykle vytvorí konfiguračný súbor (JSON) s rovnakým názvom ako plugin, prípadne dáta (domovy hráčov, cooldowny…) a jazykové súbory.
• Oxide aj Carbon používajú rovnaké pluginy. Líšia sa iba názvy priečinkov a predpona príkazov.

Kde pluginy nájsť#

• umod.org (otvorí sa v novom okne) – web projektu Oxide s tisíckami bezplatných pluginov (fungujú aj na Carbone). V zozname filtrujte hru Rust.
• Platené trhoviská a weby autorov – predávajú sa tam rozsiahlejšie pluginy (eventy, ekonomiky, mapy). Kupujte iba u pôvodného predajcu.

Pri každom plugine pred inštaláciou skontrolujte:

• Dátum poslednej aktualizácie. Plugin, ktorý nebol aktualizovaný po veľkej aktualizácii Rustu, sa nemusí preložiť.
• Popis oprávnení a príkazov na stránke pluginu. Bez nich ho nenastavíte.
• Závislosti. Niektoré pluginy potrebujú iný plugin (napríklad ImageLibrary pre obrázky v menu).

Inštalácia pluginu#

Overte, že plugin beží, výpisom pluginov v konzole:

Štruktúra priečinkov#

Rozdiel medzi konfiguráciou a dátami: konfiguráciu upravujete vy (ako sa má plugin správať), dáta si spravuje plugin sám (čo si pamätá o hráčoch). Dáta ručne neupravujte, ak presne neviete, čo robíte.

Úprava konfigurácie pluginu#

Konfigurácia má názov podľa pluginu: plugin Kits.cs má nastavenia v oxide/config/Kits.json (v Carbone carbon/configs/Kits.json). Ak súbor po načítaní pluginu nevznikol, plugin buď nič nastavovať nevie, alebo sa nenačítal (pozrite sa do logov).

Bezpečný postup, pri ktorom plugin vaše zmeny neprepíše:

Prečo najprv uvoľniť: niektoré pluginy pri uvoľnení ukladajú svoju aktuálnu konfiguráciu. Keby ste súbor upravili za behu a potom dali iba reload, plugin by vaše zmeny mohol prepísať pôvodnými hodnotami. Pri pluginoch, ktoré toto nerobia, stačí súbor uložiť a dať oxide.reload Kits (c.reload Kits).

Pravidlá JSON#

{
  "Zapnuto": true,
  "Cooldown (sekundy)": 600,
  "Uvitaci zprava": "Vitej na serveru!",
  "Povolene predmety": [
    "rock",
    "torch"
  ],
  "Barvy": {
    "Admin": "#ff5555",
    "Hrac": "#55aaff"
  }
}

• Kľúče aj texty vždy v dvojitých úvodzovkách ("Zapnuto"). Jednoduché úvodzovky JSON nepozná.
• Za každou položkou čiarka, okrem poslednej v danom bloku. Čiarka navyše pred } alebo ] je najčastejšia chyba.
• true a false malými písmenami a bez úvodzoviek. "true" v úvodzovkách je text, nie zapnuté.
• Čísla bez úvodzoviek: 600, desatinné čísla s bodkou: 1.5.
• Zoznam je v hranatých zátvorkách [ ], skupina nastavení v zložených { }.
• Komentáre JSON nepodporuje. Nemeňte názvy kľúčov, iba hodnoty za dvojbodkou.

Pred nahraním si súbor skontrolujte validátorom JSON (vie to napríklad editor Visual Studio Code, ktorý chybu podčiarkne). Keď konfiguráciu úplne pokazíte, zmažte ju a plugin znova načítajte – vytvorí si predvolený súbor.

Slovenčina, čeština a iné jazyky#

Texty, ktoré plugin posiela hráčom, sú v súboroch oxide/lang/<jazyk>/<Plugin>.json (Carbon: carbon/lang/…). Plugin vyberá jazyk podľa jazyka, ktorý má hráč nastavený v hre. Keď súbor pre jeho jazyk neexistuje, použije jazyk servera a nakoniec angličtinu.

Máte dve možnosti:

• Všetci hráči v jednom jazyku: preložte rovno anglický súbor oxide/lang/en/<Plugin>.json. Uvidí ho každý, kto nemá vlastnú jazykovú verziu.
• Preklad iba pre hráčov s danou jazykovou verziou hry: vytvorte priečinok oxide/lang/cs (pre češtinu; Rust slovenčinu v hre nemá, slovenskí hráči preto obvykle používajú češtinu alebo angličtinu), skopírujte doň anglický súbor a preložte ho. Ak hráči s češtinou v hre texty ďalej vidia anglicky, použite prvú možnosť.

Prekladajte iba texty za dvojbodkou. Zástupné znaky ako {0} alebo {player} nechajte bez zmeny, plugin za ne dosadí hodnoty. Farebné značky ako <color=#ff5555>…</color> môžete ponechať alebo upraviť. Pri aktualizácii pluginu framework do jazykového súboru iba doplní nové texty, vaše preklady zostanú.

Predvolený jazyk servera nastavíte príkazom oxide.lang cs zadaným v konzole servera (v Carbone c.lang cs).

Závislosti a rozšírenia#

Závislosť od iného pluginu spoznáte z popisu pluginu alebo z chyby v konzole (pozrite Keď niečo nefunguje). Riešenie: nainštalujte aj požadovaný plugin, rovnakým postupom do priečinka s pluginmi. Typický príklad je ImageLibrary, ktorý pre iné pluginy sťahuje a ukladá obrázky do menu.

Rozšírenie (extension) je súbor .dll, nie .cs. Používajú ho napríklad vlastné mapy z editora RustEdit alebo prepojenie s Discordom. Rozšírenia sa načítavajú iba pri štarte servera:

• Oxide: nahrajte .dll do RustDedicated_Data/Managed a server reštartujte.
• Carbon: nahrajte .dll do carbon/extensions a server reštartujte.

Pri Oxide pozor: aktualizácia hry prepisuje súbory v priečinku RustDedicated_Data/Managed. Vlastné rozšírenia Oxide.Ext.*.dll obvykle zostanú, ale keby ste priečinok Managed mazali (napríklad pri oprave poškodenej inštalácie), zmiznú. Majte ich preto zálohované aj mimo servera.

Príkazy na správu pluginov#

Za Kits dosaďte názov pluginu, teda názov súboru bez .cs. Príkazy zadávajte do konzoly servera, cez RCON, alebo ako admin do konzoly F1 v hre.

Aktualizácia pluginu#

1. Prečítajte si na stránke pluginu zoznam zmien. Hlavné verzie (napríklad 3.x na 4.x) môžu zmeniť konfiguráciu.
2. Zálohujte konfiguráciu a dáta pluginu.
3. Nahrajte nový súbor .cs cez ten starý (rovnaký názov).
4. Framework zmenu spozná a plugin sám znova načíta. V konzole uvidíte, že sa plugin uvoľnil a znova načítal.

Konfigurácia aj dáta zostávajú. Nové nastavenia, ktoré pribudli v novej verzii, si väčšina pluginov do konfigurácie doplní sama.

Odobratie pluginu#

1. Plugin uvoľnite: oxide.unload Kits (Carbon: c.unload Kits).
2. Zmažte súbor Kits.cs z priečinka s pluginmi.
3. Ak plugin už nechcete ani v budúcnosti, zmažte aj jeho konfiguráciu, dáta a jazykové súbory (súbory a priečinky s menom pluginu v config/configs, data a lang).

Oprávnenia odobraného pluginu zostávajú pridelené skupinám. Nevadí to, ale prehľadu to nepomáha. V Carbone ich uprace príkaz c.cleanup orphans.

Bezpečnosť#

• Plugin môže na serveri čokoľvek: čítať a mazať súbory, spúšťať príkazy konzoly, posielať dáta na internet. Inštalujte iba pluginy, ktorým dôverujete.
• Nikdy neinštalujte „leaknuté“ (nelegálne šírené) platené pluginy. Bývajú upravené tak, aby útočníkovi dali admin práva alebo prístup k serveru.
• Plugin je čitateľný zdrojový kód. Ak v ňom nájdete zamaskovaný kód alebo sťahovanie z neznámych adries, nepoužívajte ho.
• Heslo RCON nikdy nevkladajte do cudzích webov a nástrojov, ktoré nepoznáte.

Keď niečo nefunguje#

V konzole je Error while compiling Kits:#

Plugin sa nepodarilo preložiť. Za dvojbodkou (Oxide uvádza názov pluginu bez .cs) nasleduje zoznam chýb s číslom riadka (napríklad error CS0246). Rovnaký dôvod ukáže aj oxide.plugins pri plugine, ktorý sa nenačítal. V Carbone podobná chyba začína Failed compiling 'Kits.cs':. Najčastejšie príčiny:

• Plugin je zastaraný voči aktuálnej verzii Rustu alebo frameworku. Stiahnite najnovšiu verziu pluginu, prípadne počkajte, kým ju autor po aktualizácii Rustu vydá.
• Súbor sa stiahol poškodený (napríklad namiesto kódu webová stránka). Otvorte ho v editore: musí obsahovať kód C# (riadky using … a namespace Oxide.Plugins), nie HTML. Stiahnite ho znova.

V konzole je … plugin requires missing dependency: …#

Plugin potrebuje iný plugin, ktorý na serveri nie je. Názov chýbajúceho pluginu je na konci hlášky. Nainštalujte ho, plugin sa potom načíta sám (prípadne ho načítajte príkazom oxide.load). V Carbone hláška znie Couldn't find required plugin '…' for '…', retrying...

Plugin sa vôbec neobjavil, konzola mlčí#

• Súbor je v podpriečinku (napríklad oxide/plugins/Kits/Kits.cs). Musí byť priamo v priečinku plugins.
• Súbor má inú príponu: .cs.txt, .zip alebo .dll. Archív najprv rozbaľte v počítači a nahrajte iba .cs.
• Framework nebeží. Overte oxide.version (Carbon: c.version), pozrite Oxide a Carbon.

Zmeny v konfigurácii sa po reštarte vrátili#

Plugin súbor prepísal. Buď ste ho upravovali za behu a plugin pri uvoľnení uložil svoju verziu, alebo bol JSON neplatný a plugin vytvoril predvolené nastavenia. Postupujte podľa bezpečného postupu (uvoľniť, upraviť, načítať) a súbor vopred skontrolujte validátorom.

Plugin hlási chybu pri čítaní konfigurácie#

Chyba obvykle obsahuje JsonReaderException alebo JsonSerializationException a údaj line 12, position 5. Na uvedenom riadku je chyba v JSON, väčšinou chýbajúca alebo prebývajúca čiarka či úvodzovka. Opravte ju, alebo vráťte zálohu.

Príkaz pluginu hráčom nefunguje#

Hráči nemajú oprávnenie. Väčšina pluginov vyžaduje prideliť oprávnenie skupine default alebo konkrétnej skupine. Pozrite Oprávnenia na Rust serveri.

Ďalšie zdroje#

• Oxide: inštalácia pluginov (otvorí sa v novom okne)
• Oxide: konfigurácia pluginov (otvorí sa v novom okne)
• Oxide: preklady (localization) (otvorí sa v novom okne)
• Carbon: dokumentácia pre majiteľov serverov (otvorí sa v novom okne)
• Pluginy pre Rust na umod.org (otvorí sa v novom okne)