Developer Central - Revision history

DrMcCoy: /* Reverse engineering help */ Use Internet Archive links for the REWiki, since it seems to be dead :(

2022-07-20T13:21:03Z

Reverse engineering help: Use Internet Archive links for the REWiki, since it seems to be dead :(

← Older revision		Revision as of 13:21, 20 July 2022
Line 70:		Line 70:

	* The [http://wiki.scummvm.org/index.php/HOWTO-Reverse_Engineering HOWTO-Reverse Engineering] page in ScummVM's wiki		* The [http://wiki.scummvm.org/index.php/HOWTO-Reverse_Engineering HOWTO-Reverse Engineering] page in ScummVM's wiki
	* [http://rewiki.~~awiki~~.~~org~~/wiki/Main_Page REWiki] contains a collection of game reverse engineering knowledge. They have a [http://rewiki.~~awiki~~.~~org~~/wiki/Reverse_engineering_hints hints page] as well		* [https://web.archive.org/web/20180127174342/http://rewiki.regengedanken.de/wiki/Main_Page REWiki] contains a collection of game reverse engineering knowledge. They have a [https://web.archive.org/web/20180117223821/http://rewiki.regengedanken.de/wiki/Reverse_engineering_hints hints page] as well
	* [http://wiki.xentax.com/index.php?title=Game_File_Format_Central XentaxWiki] focuses on game file formats. They too have a [http://wiki.xentax.com/index.php?title=DGTEFF guide page]		* [http://wiki.xentax.com/index.php?title=Game_File_Format_Central XentaxWiki] focuses on game file formats. They too have a [http://wiki.xentax.com/index.php?title=DGTEFF guide page]
	* For audio and video formats, there's [http://wiki.multimedia.cx/ MultimediaWiki], which is associated with the ffmpeg and libav projects		* For audio and video formats, there's [http://wiki.multimedia.cx/ MultimediaWiki], which is associated with the ffmpeg and libav projects

DrMcCoy: /* Modding communities */ Update

2022-07-20T13:07:41Z

Modding communities: Update

← Older revision		Revision as of 13:07, 20 July 2022
Line 79:		Line 79:

	* [https://neverwintervault.org/ The Neverwinter Vault] for Neverwinter Nights and Neverwinter Nights 2		* [https://neverwintervault.org/ The Neverwinter Vault] for Neverwinter Nights and Neverwinter Nights 2
			* [https://nwn.wiki/ Neverwinter Vault Modding Wiki]
	* [http://nwn2.wikia.com/wiki/Main_Page NWN2 wiki] for Neverwinter Nights 2		* [http://nwn2.wikia.com/wiki/Main_Page NWN2 wiki] for Neverwinter Nights 2
	* [https://deadlystream.com/ Deadly Stream] for Knights of the Old Republic and Knights of the Old Republic II		* [https://deadlystream.com/ Deadly Stream] for Knights of the Old Republic and Knights of the Old Republic II
Line 86:		Line 87:
	* [http://sonicretro.org/ Sonic Retro] for Sonic Chronicles		* [http://sonicretro.org/ Sonic Retro] for Sonic Chronicles
	* [https://www.nexusmods.com/ Nexus Mods]		* [https://www.nexusmods.com/ Nexus Mods]
	* [https://~~nwnlexicon~~.~~com~~/index.php?title=Main_Page NWN Lexicon]		* [https://lexicon.nwn.wiki/index.php?title=Main_Page NWN Lexicon]

	== To do list ==		== To do list ==

	Our [[TODO\|Main TODO list]] contains a rambly, non-exhaustive collection of things left to do.		Our [[TODO\|Main TODO list]] contains a rambly, non-exhaustive collection of things left to do.

DrMcCoy: Moved IRC channel to Libera

2021-05-23T21:10:49Z

Moved IRC channel to Libera

← Older revision		Revision as of 21:10, 23 May 2021
Line 13:		Line 13:
	We strive to be a friendly and open development community. Therefore, we have adopted a [https://github.com/xoreos/xoreos/blob/master/CODE_OF_CONDUCT.md Code of Conduct] guiding us. By participating in this project you agree to abide by its terms.		We strive to be a friendly and open development community. Therefore, we have adopted a [https://github.com/xoreos/xoreos/blob/master/CODE_OF_CONDUCT.md Code of Conduct] guiding us. By participating in this project you agree to abide by its terms.

	Our main place for organizing and socializing is the [[IRC channel\|#xoreos channel on ~~Freenode~~ IRC]]. You will find most of the developers idling there, happy to answer any questions you might have. If you plan to become a frequent contributor, please consider regularly joining this channel as well.		Our main place for organizing and socializing is the [[IRC channel\|#xoreos channel on Libera IRC]]. You will find most of the developers idling there, happy to answer any questions you might have. If you plan to become a frequent contributor, please consider regularly joining this channel as well.

	However, there is not public log bot in #xoreos, so there is no public, permanent record. Therefore, discussions about far reaching changes in the codebase are best held on [[Mailing lists\|our mailing list]]. Contributors are encouraged to subscribe to this list.		However, there is not public log bot in #xoreos, so there is no public, permanent record. Therefore, discussions about far reaching changes in the codebase are best held on [[Mailing lists\|our mailing list]]. Contributors are encouraged to subscribe to this list.

DrMcCoy: Link the Compiling Phaethon page in Developer Central

2019-02-10T14:20:09Z

Link the Compiling Phaethon page in Developer Central

← Older revision		Revision as of 14:20, 10 February 2019
Line 7:		Line 7:
	== Compilation ==		== Compilation ==

	See the [[Compiling xoreos]] ~~and~~ [[Compiling xoreos-tools]] pages for information on how to compile our source code on various operating systems.		See the [[Compiling xoreos]], [[Compiling xoreos-tools]] and [[Compiling Phaethon]] pages for information on how to compile our source code on various operating systems.

	== Community ==		== Community ==

DrMcCoy at 16:54, 26 June 2018

2018-06-26T16:54:07Z

← Older revision		Revision as of 16:54, 26 June 2018
Line 60:		Line 60:

	When writing new common classes, or adding functionality to existing ones, also writing new unit tests checking the new functionality is hugely appreciated.		When writing new common classes, or adding functionality to existing ones, also writing new unit tests checking the new functionality is hugely appreciated.

			== Releases ==

			A short overview on how xoreos releases work can be found on the [[Releases]] page.

	== Reverse engineering help ==		== Reverse engineering help ==

DrMcCoy at 20:58, 17 June 2018

2018-06-17T20:58:35Z

@@ Line 69: / Line 69: @@
 * [http://wiki.xentax.com/index.php?title=Game_File_Format_Central XentaxWiki] focuses on game file formats. They too have a [http://wiki.xentax.com/index.php?title=DGTEFF guide page]
 * For audio and video formats, there's [http://wiki.multimedia.cx/ MultimediaWiki], which is associated with the ffmpeg and libav projects
 == To do list ==
 Our [[TODO|Main TODO list]] contains a rambly, non-exhaustive collection of things left to do.

DrMcCoy: /* Reverse engineering help */ Update REWiki URLs

2018-05-20T23:49:50Z

Reverse engineering help: Update REWiki URLs

← Older revision		Revision as of 23:49, 20 May 2018
Line 66:		Line 66:

	* The [http://wiki.scummvm.org/index.php/HOWTO-Reverse_Engineering HOWTO-Reverse Engineering] page in ScummVM's wiki		* The [http://wiki.scummvm.org/index.php/HOWTO-Reverse_Engineering HOWTO-Reverse Engineering] page in ScummVM's wiki
	* [http://rewiki.~~regengedanken~~.de/wiki/Main_Page REWiki] contains a collection of game reverse engineering knowledge. They have a [http://rewiki.~~regengedanken~~.de/wiki/Reverse_engineering_hints hints page] as well		* [http://rewiki.awiki.org/wiki/Main_Page REWiki] contains a collection of game reverse engineering knowledge. They have a [http://rewiki.awiki.org/wiki/Reverse_engineering_hints hints page] as well
	* [http://wiki.xentax.com/index.php?title=Game_File_Format_Central XentaxWiki] focuses on game file formats. They too have a [http://wiki.xentax.com/index.php?title=DGTEFF guide page]		* [http://wiki.xentax.com/index.php?title=Game_File_Format_Central XentaxWiki] focuses on game file formats. They too have a [http://wiki.xentax.com/index.php?title=DGTEFF guide page]
	* For audio and video formats, there's [http://wiki.multimedia.cx/ MultimediaWiki], which is associated with the ffmpeg and libav projects		* For audio and video formats, there's [http://wiki.multimedia.cx/ MultimediaWiki], which is associated with the ffmpeg and libav projects

DrMcCoy: Describe our unit tests

2017-02-28T19:39:06Z

Describe our unit tests

← Older revision		Revision as of 19:39, 28 February 2017
Line 52:		Line 52:

	The public xoreos repositories are build by two [https://en.wikipedia.org/wiki/Continuous_integration Continuous Integration] services on every push: [https://travis-ci.org/ Travis CI] (for GNU/Linux, using both the autotools and the CMake build systems and also using both gcc and clang) and [https://www.appveyor.com/ AppVeyor] (for Windows, using Microsoft Visual Studio). If a compilation error occurs, the build failure announced is on our [https://wiki.xoreos.org/index.php?title=IRC_channel IRC channel], so that it may be fixed quickly. Pull Requests are also run through these CI services and we like to have all failures fixed before merging.		The public xoreos repositories are build by two [https://en.wikipedia.org/wiki/Continuous_integration Continuous Integration] services on every push: [https://travis-ci.org/ Travis CI] (for GNU/Linux, using both the autotools and the CMake build systems and also using both gcc and clang) and [https://www.appveyor.com/ AppVeyor] (for Windows, using Microsoft Visual Studio). If a compilation error occurs, the build failure announced is on our [https://wiki.xoreos.org/index.php?title=IRC_channel IRC channel], so that it may be fixed quickly. Pull Requests are also run through these CI services and we like to have all failures fixed before merging.

			== Unit tests ==

			The xoreos repositories also provide unit tests for many common classes. These are build and run right after the main binaries on every push, by the CI services we use. A failure in one of these unit tests leads to the build being treated as failed. That way, it's immediately obvious when we break anything.

			All xoreos developers are advised to run these unit tests themselves while writing code that touches the common code. In both of our build systems, "make check" does exactly this.

			When writing new common classes, or adding functionality to existing ones, also writing new unit tests checking the new functionality is hugely appreciated.

	== Reverse engineering help ==		== Reverse engineering help ==

DrMcCoy: Describe the CI services we use

2017-02-28T19:32:49Z

Describe the CI services we use

← Older revision		Revision as of 19:32, 28 February 2017
Line 48:		Line 48:

	To avoid people accidentally working on the same feature, or otherwise stepping on each others' toes, consider announcement what you are working on in the [[IRC channel]] or the [[Mailing lists\|mailing list]].		To avoid people accidentally working on the same feature, or otherwise stepping on each others' toes, consider announcement what you are working on in the [[IRC channel]] or the [[Mailing lists\|mailing list]].

			== Continuous Integration ==

			The public xoreos repositories are build by two [https://en.wikipedia.org/wiki/Continuous_integration Continuous Integration] services on every push: [https://travis-ci.org/ Travis CI] (for GNU/Linux, using both the autotools and the CMake build systems and also using both gcc and clang) and [https://www.appveyor.com/ AppVeyor] (for Windows, using Microsoft Visual Studio). If a compilation error occurs, the build failure announced is on our [https://wiki.xoreos.org/index.php?title=IRC_channel IRC channel], so that it may be fixed quickly. Pull Requests are also run through these CI services and we like to have all failures fixed before merging.

	== Reverse engineering help ==		== Reverse engineering help ==

DrMcCoy: Restructure and extend developer information

2015-12-04T15:54:03Z

Restructure and extend developer information

@@ Line 1: / Line 1: @@
 The purpose of this page is to give a link to all kinds of resources that contain information valuable to current and future developers of xoreos.
-== Getting started ==
+The main xoreos source repositories are hosted on [https://github.com/xoreos/ GitHub]. Please see the [[Git]] page on details on how the repositories are structured and how to retrieve the code.
-That was easy, right? Here are some more tips:
+== Compilation ==
-* Please read our [https://github.com/xoreos/xoreos/blob/master/CODE_OF_CONDUCT.md Code of Conduct]. By participating in this project you agree to abide by its terms.
+See the [[Compiling xoreos]] and [[Compiling xoreos-tools]] pages for information on how to compile our source code on various operating systems.
-* Before you write/submit code, '''you must read''' our [[Code Formatting Conventions]].<br>Patches which do not follow them will be rejected or at least delayed until they are cleaned up to comply to them.
-* If you have write (push) access to our repository, you are expected to have read and to comply with our [[Commit Guidelines]].<br>Also, please read the tips for using Git here: [http://wiki.scummvm.org/index.php/Git_tips Git tips].<br>In particular, note the use of feature branches, when working on refactoring or other large connected changes, rather than committing directly to xoreos/master.
+== Community ==
-* If you do not have write (push) access to our repository, you should submit your contributions by the following method:
-** Using a [https://help.github.com/articles/using-pull-requests Github Pull Request].<br> This requires you to have/register a github account, fork our repository, commit your changes to a branch and then issue a Pull Request.<br>This is the current preferred method as it is easier for the team to review, discuss and amend prior to merging.<br>You are expected to have read and to comply with our [[Commit Guidelines]].
+We strive to be a friendly and open development community. Therefore, we have adopted a [https://github.com/xoreos/xoreos/blob/master/CODE_OF_CONDUCT.md Code of Conduct] guiding us. By participating in this project you agree to abide by its terms.
 == Reverse engineering help ==
@@ Line 22: / Line 57: @@
 * [http://wiki.xentax.com/index.php?title=Game_File_Format_Central XentaxWiki] focuses on game file formats. They too have a [http://wiki.xentax.com/index.php?title=DGTEFF guide page]
 * For audio and video formats, there's [http://wiki.multimedia.cx/ MultimediaWiki], which is associated with the ffmpeg and libav projects
 == To do list ==
 Our [[TODO|Main TODO list]] contains a rambly, non-exhaustive collection of things left to do.