Csomagkészítés az openBVE tartalomkezelőjéhez
| Figyelem! Ez a lap fejlesztők számára készült! Ha csak játszani akarsz, ezt nem kell elolvasnod. |
Ez a lap az openBVE programban elérhető tartalomkezelőhöz készíthető csomag leírását tartalmazza. A dokumentum eredetije itt található: http://trainsimframework.org/develop/managed/index.html
Tartalomjegyzék |
Követelmények
Létezik néhány olyan alapfeltétel, amelyeknek meg kell felelned ahhoz, hogy az általad készített kiegészítő bekerüljön az openBVE tartalomkezelőjébe.
Készítő
Csak az eredeti szerző tölthet fel kiegészítőket a tartalomkezelőbe. Ez azt is jelenti, hogy nem tölthetsz fel régi, felhagyott kiegészítőket, hacsak nem te készítetted őket.
Jogok
Azért, hogy a kiegészítők örökre elérhetőek maradjanak visszavonhatatlan engedélyt kell adnod mindenkinek arra, hogy másolatot készíthessenek a kiegészítődről mindenféle feltétel vagy kikötés nélkül (kivéve, ha közkincsként adod ki a művedet). Lehetőséged van további jogokat is biztosítani az általad meghatározott feltételek szerint.
Szerver
Az összes kiegészítőt olyan szerveren kell tárolni, ahol a fájlok közvetlenül, korlátozás nélkül elérhetőek függetlenül bármilyen körülménytől (így például attól, hogy honnan érkezik a látogató, hol tartózkodik, stb.). Eszerint nem használhatóak az olyan népszerű szolgáltatók, mint a data.hu, Rapidshare, Mediafire és hasonlók, mivel nem engedélyezik a fájlok közvetlen elérését ingyenesen.
Használhatóság
A tartalomkezelőben kiadott pályáknak használhatóaknak kell lenniük. Ez alapvetően azt jelenti, hogy lennie kell legalább két állomásnak és meghatározott vonatnak belső nézettel.
Bevezetés
A játékosoknak nem kell tudniuk, hogy mi zajlik a színfalak mögött, amikor megnyitják a kiegészítők letöltése menüt, és pályákat, vonatokat telepítenek. Te viszont fejlesztő vagy, így fontos, hogy megértsd és jól ismerd a rendszer működését, ha a kiegészítőidet a tartalomkezelőben szeretnéd megjelentetni.
Csomagtípusok
Legelőször is, tudni kell, hogy a tartalomkezelőhöz a kiegészítőket csomagokba rendezzük (angolul: package). Négy fajta csomag létezik:
Pályák (Routes)
Ezek a csomagok a menüben kiválasztható pályákat tartalmazzák. Tartalmazhatnak bármi mást is: például textúrákat, objektumokat vagy éppen hangokat.
Vonatok (Trains)
Ezek a csomagok a menüben kiválasztható vonatokat tartalmazzák. Tartalmazhatnak bármi mást is: például textúrákat, objektumokat vagy éppen hangokat.
Könyvtárak (Libraries)
Ezek a csomagok nem tartalmaznak semmi olyant, amit a játékosok közvetlenül elérhetnének a menüből. Ehelyett inkább egyéb fájlokat tartalmaznak, mint például textúrák, objektumok, hangok. Ez akkor hasznos, ha a kiegészítőt több csomagra akarod bontani.
Ezek hasonlítanak a könyvtárakra, de kifejezetten azzal a céllal készülnek, hogy más fejlesztők is felhasználhassák őket. Így visszamenőlegesen kompatibilisnak kell maradniuk.
A csomagok előnyei
Az egyik előnye a csomagoknak, hogy a kiegészítőket több csomagra lehet bontani. Fontos, hogy a pályákat és a vonatokat mindenképpen külön csomagba kell tenned. De további csomagokra oszthatod a kiegészítőt, ha akarod. Például, létrehozhatsz különálló csomagokat a háttérképeknek, a síneknek, a jelzőknek, és az épületeknek. Ennek az az előnye, hogy később frissíteni tudod bármelyik csomagot, és a játékosoknak nem kell letölteniük a teljes kiegészítőt, csak azt az egy csomagot, amit frissítettél.
A csomagok felépítése lehetővé teszi, hogy újrahasználj csomagokat más kiegészítőkben. Például megoszthatod a jelzőidet más kiegészítőkben is. Az előnye, hogy a játékosoknak csak egyszer kell letölteniük a jelzőcsomagot, nem külön-külön minden pályához, és ha készítesz egy javítást a jelzőidhez, minden pálya automatikusan az újabb jelzőket fogja használni.
A csomagok tulajdonságai
Minden csomag rendelkezik egy névvel és egy verziószámmal, és minden verziószámmal ellátott csomag méret és MD5 szerint van azonosítva, hogy a letöltés során sérült csomagok ne települhessenek. Ez azt is jelenti, hogy ha egy csomagot szeretnél frissíteni, akkor növelned kell a verziószámát, mert ha egyszer megváltoztatsz egy csomagot, akkor annak elkerülhetetlenül megváltozik a mérete és az MD5-je.
Ha egy kiegészítőt több részre bontasz, akkor az elsődleges pálya- vagy vonatcsomag más könyvtárcsomagoktól fog függeni. Ez a függőség egy alapvető tulajdonsága minden csomagnak. Enélkül az openBVE nem tudná automatikusan letölteni a szükséges kiegészítőit a csomagoknak, ebből következően az adott kiegészítő nem működne rendeltetésszerűen.
A kiegészítők nyújthatnak különféle javaslatokat. Például ha egy pályát töltesz fel, javasolhatsz mellé egy megfelelő járművet. Fontos megérteni, hogy a pálya működhet a szükséges vonat nélkül is, tehát az alap jármű nem alapkövetelmény.
Leírások, útmutatók
A következő leírásokban részletes magyarázatot találsz minden tudnivalóról a csomagkészítéssel kapcsolatban.
Alapvető tudnivalók
Tudnivalók haladó fejlesztők számára
- Kiegészítők felosztása több csomagba
- Megosztott könyvtárak készítése
- A leíró fájlban szereplő adatok
