|
|
(77 intermediate revisions by 12 users not shown) |
Line 1: |
Line 1: |
| <!-- | | <div style="overflow-x:scroll"> |
| Notes area.
| | {{Alert|Note: OuroDev is purely a not-for-profit, volunteer group. Anyone asking for donations on behalf of OuroDev or any of its contributors does not represent the group and should be ignored.}} |
| | |
| Stole some of the layout inspiration from gametech emugen wiki.
| |
| | |
| TODO: Adapt the structure of the main page to move Howtos to their own sections, and also consolidate specific component topics. I sent the below suggested basic structure to TMC earlier. This is simply a concept for content and organization, and it doesn't have to be followed to the letter, but these are my thoughts in any case. --Bevinsky
| |
| | |
| Walkthroughs
| |
| - [[Basic i24 Walkthrough]]
| |
| - [[Basic i25 Walkthrough]]
| |
|
| |
| # i24 and i25 are very similar. Instead of having separate pages
| |
| # for each of these items, it might be better to cover differences on each page.
| |
| # -- Perhaps this is not a desired idea?
| |
| | |
| # document directory structure:
| |
| # - Executable/datadir structure
| |
| # - other dirs, such as C:\coh_data\attributes?
| |
| [[Directories]]
| |
| | |
| # Should assemble magnet links for specific assets?
| |
| [[Assets]] # explain client piggs/bins, server bins, maps, SpawnAreas, script.loc
| |
| - [[maps.db]] # Usage, format and directives
| |
| - [[Templates & Attributes]] # template purpose, usage, generation method, and syntax
| |
|
| |
|
| # Document for each:
| | {| style="width:100%; background:#fafafa; margin-top: 0.6em; border:1px solid #a2a9b1; padding: 0 4% 0 8%;" |
| # - Location | | | style="width:65%;" | |
| # - Purpose, usage
| |
| # - Full directive reference / file format
| |
| Configurations
| |
| - [[gamedatadir.txt]]
| |
| - [[servers.cfg]]
| |
| - [[loadBalance]] # for both loadBalanceDefault.cfg and loadBalanceShardSpecific.cfg
| |
| - [[auction_server.cfg]]
| |
| - [[account_server.cfg]]
| |
| - [[chat_server.cfg]]
| |
| - [[commands.cfg]]
| |
| - [[weeklytf.cfg]] # shouldn't this be "weeklyTF.cfg"? is this changed in i25 or is it case-insensitive?
| |
| - [[version.ini]]
| |
|
| |
|
| # Document for each component:
| | {| style="border:none; background:none;" |
| # - basic purpose, usage
| |
| # - command line flags reference
| |
| # - common issues
| |
| # - etc.
| |
| [[Servers]] # Architecture description?
| |
| - [[DBserver]]
| |
| - [[Mapserver]]
| |
| - [[Launcher]]
| |
| - [[Chatserver]]
| |
| - [[Authserver]]
| |
| - [[Accountserver]]
| |
| - [[Arenaserver]]
| |
| - [[Missionserver]]
| |
| - [[Auctionserver]]
| |
| - etc? are there more?
| |
| | |
| Tools
| |
| - [[pig.exe]]
| |
| - [[ServerMonitor]]
| |
| | |
| Protocols?
| |
| - Inter-server?
| |
| - ?
| |
| - Server-client?
| |
| - [[Client-to-authserver]]
| |
| - [[Client-to-dbserver]]
| |
| - [[Client-to-mapserver]]
| |
| | |
| Formats?
| |
| - [[PIGG]] # pig.exe
| |
| - [[Parse6]]
| |
| - [[Parse7]]
| |
| | |
| | |
| | |
| -->
| |
| {| style="width:100%; background:#4a2a2a; margin-top: 0.6em; border:1px solid #a2a9b1; text-align:center; font-weight:bold" | |
| ||
| |
| Note: OuroDev is purely a not-for-profit, volunteer group. Anyone asking for donations on behalf of OuroDev or any of its contributors does not represent the group and should be ignored.
| |
| |}
| |
| | |
| {| style="width:100%; background:#2a2a2a; margin-top: 0.6em; border:1px solid #a2a9b1; padding: 0 8%;"
| |
| | style="width:15%;" |
| |
| | |
| {| style="width:100px; border:none; background:none;"
| |
| | style="text-align:center; white-space:nowrap;" | | | | style="text-align:center; white-space:nowrap;" | |
| <div style="font-size:162%; border:none; padding:.1em;">Welcome to OuroWiki,</div> | | <div style="font-size:162%; border:none; padding:.1em;">Welcome to OuroWiki,</div> |
| <div style="top:+0.2em; font-size:95%;">the Ouroboros Project wiki.</div> | | <div style="top:+0.2em; font-size:95%;">the Project Ouroboros Development wiki.</div> |
| <div id="articlecount" style="width:100%; text-align:center; font-size:85%;">There are [[Special:Statistics|{{NUMBEROFARTICLES}}]] articles already. Why not explore them?</div> | | <div id="articlecount" style="width:100%; text-align:center; font-size:85%;">We are hosting [[Special:AllPages|{{NUMBEROFPAGES}}]] pages.</div> |
| | <div id="visionstatement" style="width:100%; text-align:center; font-size: 85%">Please read our [[OuroDev_Volume_2_Vision|Vision Statement]].</div> |
| |} | | |} |
| | | <!-- |
| | style="width:40%; font-size:85%; padding:0.6em; padding-right:5%" | | | | style="width:40%; font-size:85%; padding:0.6em; padding-right:5%" | |
| The '''Ouroboros Project''' is an ongoing volunteer effort that is taking a three-pronged approach to making City of Heroes available to the public: | | The '''Ouroboros''' Project is an ongoing volunteer effort. Please read our [[OuroDev_Volume_2_Vision|Vision Statement]]. |
| # Actively providing documentation and support for setting up private deployments using released 'i25' binaries and 'i24' source.
| | --> |
| # Maintaining and releasing stable builds of the 'i24' client and server, including a public git repo and public bug tracker.
| | | style="width:35%; white-space:nowrap;" | |
| # Providing a public wiki for documentation and transparency.
| | :[[File:Discord.png|30x30px|link=OuroDev Discord]] <span style="font-size:120%">[[OuroDev Discord|Discord]]</span> <span style="font-size:85%">(Discussion)</span> |
| | | :[[File:GitLab Icon.png|30x30px|link=https://git.ourodev.com/CoX/Source]] <span style="font-size:120%">[https://git.ourodev.com/CoX/Source Gitlab]</span> <span style="font-size:85%">(Source code, bug tracking)</span> |
| | style="width:10%; font-size:120%; white-space:nowrap;" | | | :[[File:PortalCorps.png|30x30px|link=Portal Corps]] <span style="font-size:120%">[[Portal Corps]]</span> <span style="font-size:85%">(Content creation)</span> |
| : [[File:Gitea.png|30px|link=https://git.ourodev.com/CoX/Source]] [https://git.ourodev.com/CoX/Source Gitea] | |
| : [[File:Mantis.png|30px|link=https://bugs.ourodev.com/]] [https://bugs.ourodev.com/ Mantis] | |
| : [[File:Discord.png|30px|link=OuroDev Discord]] [[OuroDev Discord|Discord]] | |
| |} | | |} |
|
| |
|
| {| style="width:100%; margin-top: 0.6em" | | {| style="width:100%; margin-top: 0.6em" |
| | style="width:75%;vertical-align:top;padding-right:0.6em" | | | | colspan="2" style="width:50%; background:#fafafa; border:1px solid #a2a9b1; padding:0.6em; vertical-align:top" | |
| {| style="width:100%; background:#2a2a2a; border:1px solid #a2a9b1; padding:0.6em; vertical-align:top"
| | |
| | style="width:100%" colspan=4 |
| | <h2 style="margin-top:0;padding-top:0">Volume 2</h2> |
| <h2 style="padding-top:0;margin-top:0">[[Server Architecture]]</h2> | | Volume 2 is the main focus of OuroDev's ongoing efforts to clean up and modernize the City of Heroes (CoH) code, completely open source. The current version is "''Issue 2: Foundations of Tomorrow"'' |
| |- | | |
| | style="width:25%; vertical-align:top" |
| | It is a stable base for server owners to deploy, and is built off of Issue 24 (stylized as i24), the last open beta version of the game before it was shut down. |
| <h3 style="padding-top:0;margin-top:0"> Assets </h3>
| | |- style="vertical-align:top" |
| * [[Server directory structure|Directory structure]]
| | | |
| ==== Binary assets ==== | | ====Volume 2 Server Setup==== |
| * [[BCN maps]] | | |
| ==== Textual assets ====
| | *[[Volume 2 VMs & Self Installer|Volume 2 VMs & Self Installer]] |
| * [[maps.db]] ''configuration?'' | | *[[Volume 2 Server Setup|Volume 2 Getting Started]] |
| * [[script.loc]] | | *[[Volume_2_Modifying_Server_For_External_Access|Volume 2 Modifying Server For External Access]] |
| * [[SpawnArea]] | | *[[Volume_2_Client_setup|Volume 2 Client setup]] |
| * [[Templates]]
| | | |
| | ====Volume 2 From Source==== |
|
| |
|
| | style="width:25%; vertical-align:top" |
| | *[[Volume_2_Build|Volume 2 Build from Source]] |
| <h3 style="padding-top:0;margin-top:0"> Components </h3>
| | *[[Volume 2 Generate Bins]] |
| * [[dbserver]] | | |- style="vertical-align:top" |
| * [[mapserver]] | | | |
| * [[launcher]]
| | ====Volume 2 Details==== |
| * [[chatserver]]
| |
| * [[authserver]]
| |
| * [[accountserver]]
| |
| * [[arenaserver]]
| |
| * [[missionserver]]
| |
| * [[auctionserver]]
| |
|
| |
|
| | style="width:25%; vertical-align:top" |
| | *[[OuroDev_Volume_2_Vision|Volume 2 Vision]] |
| <h3 style="padding-top:0;margin-top:0"> Configurations </h3>
| | *[[Volume_2_Release_Notes|Volume 2 Release Notes]] |
| * [[servers.cfg]] | | *[https://git.ourodev.com/groups/CoX/-/milestones Volume 2 Roadmap] |
| * [[loadBalance]] | | *[https://git.ourodev.com/CoX/Source Volume 2 Source] |
| * [[auction_server.cfg]] | | *[https://git.ourodev.com/CoX/i2401-bin-server Volume 2 Data] |
| * [[account_server.cfg]] | | | |
| * [[chat_server.cfg]] | | ====Volume 2 Workflow==== |
| * [[commands.cfg]]
| |
| * [[weeklytf.cfg]]
| |
| * [[Other configurations]]
| |
|
| |
|
| | style="width:25%;vertical-align:top" | | | *[[OuroDev_Git_Workflow|OuroDev Git Workflow]] |
| <h3 style="padding-top:0;margin-top:0"> Tools </h3>
| | *[[OuroDev_issue_tracker_workflow|OuroDev Issue Tracker Workflow]] |
| * [[pig.exe]] | | *[[OuroDev_QA_workflow|OuroDev QA Workflow]] |
| * [[ServerMonitor]] | | *[[OuroDev_Code_Style_Guide|OuroDev Code Style Guide]] |
| * [[dbquery.exe]] | | *[[OuroDev_Bug_Report_Guidelines|OuroDev Bug report Guidelines]] |
| | |- style="vertical-align:top" |
| | | |
| | ====Launchers and Manifests==== |
|
| |
|
| === Protocols ===
| | *[[Manifest Launchers]] |
| * [[Network protocol]] | | *[[Manifest Creation]] |
| ==== Client-server protocols ''Does this need its own page?'' ====
| | *[[Sunrise Launcher]] |
| * [[Client-to-authserver]] | | *[[Sunrise API]] |
| * [[Client-to-dbserver]] | |
| * [[Client-to-mapserver]] | |
| ==== Server protocols ====
| |
| * [[Dbserver-to-mapserver]]
| |
|
| |
|
| |} | | <br /> |
| | style="width:25%;vertical-align:top" |
| | | |
| {| style="width:100%; background:#2a2a2a; border:1px solid #a2a9b1; padding:0.6em; vertical-align:top"
| | ====Modding==== |
| | style="width:100%" colspan=1 |
| |
| <h2 style="padding-top:0;margin-top:0">[[Client Architecture]]</h2>
| |
| |-
| |
| | style="width:100%;" |
| |
| <h3 style="padding-top:0;margin-top:0"> TODO </h3>
| |
| * TODO
| |
| |}
| |
|
| |
|
| |} | | *[https://git.ourodev.com/mods Community Mods] |
| | *[[Bin List]] |
| | *[[Binning File Layout]] |
| | *[[XLS to data conversion]] |
| | *[[Portal Corps|Portal Corps Modding Guides]] |
| | *[[Piglet|Piglet]] |
| | *[https://git.ourodev.com/community Community Tools] |
| | |- style="vertical-align:top" |
| | | |
| | ====Useful References==== |
|
| |
|
| {| style="width:100%; background:#2a2a2a; margin-top: 0.6em; border:1px solid #a2a9b1; text-align:center; font-size:130%"
| | *[[Magnet Links]] |
| | style="width:50%" | | | *[[Admin_Commands_(in-game)|Admin Commands (in-game)]] |
| [[i24 install guide|I want to help develop!]] | | *[[Combat Log |Combat Log]] |
| | style="width:50%" |
| | *[[Server Executable Flags]] |
| [[i25 Community Virtual Machines|I just want to run a server!]] | | *[[Badge List]] |
| |}
| | *[[Salvage List]] |
| | *[[Using /mmm]] (in-game console) |
| | *[[VidiotMaps]] |
| | *[https://cohrevival.com/codex/models.html Model Index] |
|
| |
|
| {| style="width:100%; margin-top: 0.6em"
| | <br /> |
| | style="width:50%; background:#2a2a2a; border:1px solid #a2a9b1; padding:0.6em; vertical-align:top" |
| | | |
| | ====I25/I26==== |
|
| |
|
| <h2 style="margin-top:0;padding-top:0">Issue 24</h2>
| | *[[I25 Main Page]] |
| Issue 24 (stylized as i24) was the last publicly accessible version of the game before it was shut down. i24 was deployed on the test server, but had not yet been released to live servers.
| | *[[I25 Main Page#Server Setup Guide]] |
| | *[[I25 Main Page#Reference Documents]] |
|
| |
|
| === Guides === | | <br /> |
| * Setup guide: https://docs.google.com/document/d/10FimduxDEM3UT1g7b6y3UHAETSjUl5lYzaG7fbUn-Vc/edit# (this is slowly being migrated over to here on the wiki).
| | |- style="vertical-align:top" |
| * [[source locations|Where to get the source]]
| | | colspan="2" | |
| * [[i24_install_guide|Install guide for setting up i24]]
| | {| style="width:100%; background:#fafafa; border:1px solid #a2a9b1; padding:0.6em; vertical-align:top" |
| * [[i24 Common Setup Issues]]
| | | colspan="4" style="width:100%" | |
| * [[i24 Commands|i24 admin commands (in-game)]]
| | <h2 style="padding-top:0;margin-top:0">[[How It Fits Together|Architecture]]</h2> |
| * [[Server Configuration Values]]
| | |- style="vertical-align:top" |
| * [[Server Executable Flags]]
| | | style="width:25%; vertical-align:top" | |
| * [[Using /mmm]] (in-game console)
| | <h5 style="padding-top:0;margin-top:0"> Assets </h5> |
|
| |
|
| === Documentation ===
| | *[[Server directory structure|Directory structure]] |
| * [[system_architecture_image|System Architecture Image]] | | *[[system_architecture_image|System Architecture Image]] |
| * [[map_server_overview|Map Server]] | | *[[Piggs]] and [[Hoggs]] |
|
| |
|
| === Tools Needed === | | =====Binary assets===== |
| * An installation of Windows (verified working: 10 Pro, Server 2019 Standard)
| |
| * [http://download.microsoft.com/download/D/B/C/DBC11267-9597-46FF-8377-E194A73970D6/vs_proweb.exe Visual Studio 2010 Professional] Web download
| |
| * [https://www.microsoft.com/en-us/download/details.aspx?id=29062 Microsoft® SQL Server® 2012 Express]
| |
| * [https://docs.microsoft.com/en-us/sql/ssms/download-sql-server-management-studio-ssms?view=sql-server-2017 SQL Server Management Studio] (SMSS)
| |
|
| |
|
| === Torrent links ===
| | *[[BCN maps]] |
| * Putting this here for now, can go away once we have the repository set up: | | *[[.bin files]] |
| ** [[magnet links]]
| |
|
| |
|
| === Useful Future Links? === | | =====Textual assets===== |
| * [https://cohrevival.com/codex/models.html Model Index]
| |
|
| |
|
| === Git Repository ===
| | *[[maps.db]] |
| * [[OuroDev_Git_Workflow|OuroDev Git Workflow]] ''TODO: move this to an OuroDev section'' | | *[[script.loc]] |
| | *[[SpawnArea]] |
| | *[[Templates]] |
| | *[[.def_Files]] |
|
| |
|
| | style="width:50%; background:#2a2a2a; border:1px solid #a2a9b1; padding:0.6em; vertical-align:top" | | | | style="width:25%; vertical-align:top" | |
| | <h5 style="padding-top:0;margin-top:0"> Components </h5> |
|
| |
|
| <h2 style="margin-top:0;padding-top:0">[[i25 Main Page|Issue 25]]</h2>
| | *[[accountserver]] |
| Issue 25 (stylized as i25) was extended from an i24 base by SCoRE (Secret Cabal of Reverse Engineers) over the course of six years. It included additional content for i24 power sets, added the P2W Vendor, and fixed a good number of bugs.
| | *[[arenaserver]] |
| | *[[auctionserver]] |
| | *[[AuthServer]] |
| | *[[beaconizer]] |
| | *[[chatserver]] |
| | *[[dbserver]] |
| | *[[launcher]] |
| | *[[mapserver]] |
| | *[[missionserver]] |
| | *[[queueserver]] |
|
| |
|
| === Client Setup Guide === | | | style="width:25%; vertical-align:top" | |
| * [[i25 Client Setup]]
| | <h5 style="padding-top:0;margin-top:0"> Configurations </h5> |
|
| |
|
| === Server Setup Guide ===
| | *[[account_server.cfg]] |
| * [[i25 Server Setup]] | | *[[auction_server.cfg]] |
| * [[i25 Multiple Server Setup]] | | *[[chat_server.cfg]] |
| * [[i25 Community Virtual Machines]] | | *[[commands.cfg]] |
| * [https://gofile.io/?c=w56I8R Video Guide from scratch] | | *[[config.txt]] |
| * [https://docs.google.com/document/d/1N63pPUfll-PAiElfGatSqCvX7GHZ8ygHWHAYbAV5il0/edit Original Setup Instructions on Google Drive] | | *[[loadBalance]] |
| | *[[servers.cfg]] |
| | *[[turnstile_server.cfg]] |
| | *[[version.ini]] |
| | *[[weeklytf.cfg]] |
|
| |
|
| === Commonly Asked Questions/Problems === | | | style="width:25%;vertical-align:top" | |
| * [[i25 FAQ]]
| | <h5 style="padding-top:0;margin-top:0"> Tools </h5> |
| * [[i25 Current Status]]
| |
| * [[i25 Command Lists]]
| |
|
| |
|
| === Community Tools===
| | *[[Client Mirror Distribution Project]] |
| * [[i25 Community Tools]] | | *[[dbquery.exe]] |
| | *[[ServerMonitor]] |
|
| |
|
| === Downloads === | | =====Protocols===== |
| * [[i25 Downloads]]
| |
|
| |
|
| === Reference Documents ===
| | *[[Network protocol]] |
| * [https://drive.google.com/file/d/1eZqIZnhEYDoRAJeoCotyKhWZZG07mrft/view City of Heroes Document] | |
|
| |
|
| === i25 Patch Notes === | | =====Client-server protocols===== |
| * [https://docs.google.com/document/d/11cLJiSYlfueJheOumRywG8Evip2Mjmu_30Y6ePaetqY i25 Patch Notes]
| |
|
| |
|
| |}
| | *[[Client-to-authserver]] |
| | *[[Client-to-dbserver]] |
| | *[[Client-to-mapserver]] |
|
| |
|
| {| style="width:100%; background:#2a2a2a; margin-top: 0.6em; border:1px solid #a2a9b1; padding:0.6em; vertical-align: top"
| | =====Server protocols===== |
| | style="width:100%; vertical-align:top" |
| |
|
| |
|
| == Quality of Life ==
| | *[[Beaconizer-protocols]] |
| * [[VidiotMaps]] (suitable for use with either i24 or i25) | | *[[Dbserver-protocols]] |
| * [[Account_Portal]] (A PHP application to allow users to create their own accounts and change their passwords.) | |
|
| |
|
| |} | | |} |
| | |}</div> |
|
| |
|
| __NOTOC__ | | __NOTOC__ |