From The Mana World
(step-by-step guide for creating a windows installer)
m (Small updates and encoding fixes)
 
(12 intermediate revisions by 6 users not shown)
Line 3: Line 3:
The program version and release date are mentioned in several places. Some other places are also important to check before making a release.
The program version and release date are mentioned in several places. Some other places are also important to check before making a release.


* <code>configure.ac</code> (version)
* <code>CMakeLists.txt</code> - version
* <code>CMakeLists.txt</code> (version)
* <code>INSTALL</code> - dependencies and their versions
* <code>src/main.h</code> (version)
* <code>NEWS</code> - version, release date and changes
* <code>src/winver.h</code> (version)
* <code>data/help/changes.txt</code> - version, release date and changes
* <code>README</code> (version and release date)
* <code>data/help/header.txt</code> - version and release date
* <code>INSTALL</code> (dependencies and their versions)
* <code>src/main.h</code> - version
* <code>NEWS</code> (version, release date and changes)
* <code>src/winver.h</code> - version
* <code>data/help/header.txt</code> (version and release date)
* <code>packaging/windows/setup.nsi</code> - version
* <code>data/help/changes.txt</code> (version, release date and changes)


=== Making a clean tarball ===
=== Making a clean tarball ===


Authors and packagers should work on making a clean tarball, which has no .git folders, no Makefiles, no .deps folders, etc... That kind of clean is needed when uploading sources such as for debian, and can be obtained thanks to <code>make dist</code>, with automake.
Authors and packagers should work on making a clean tarball, which has no .git folders, no Makefiles, no .deps folders, etc... That kind of clean is needed when uploading sources such as for Debian, and can be obtained thanks to <code>make dist</code>, with automake.


To test that the distribution compiles and installs with just the files included in the release, <code>make distcheck</code> can be used. However, you should also make sure that it actually runs.
To test that the distribution compiles and installs with just the files included in the release, <code>make distcheck</code> can be used. However, you should also make sure that it actually runs.
=== Creating a windows installer ===
First time setup:
# [[Git repository|Clone the Git repository of the eAthena client]]. The directory where you have the cloned repository will now be referred to as "TMW"
# Get [http://nsis.sourceforge.net Nullsoft Scriptable Install System]
# Install [http://upx.sourceforge.net/ UPX] (the script expects upx to be in a "upx" subdirectory)
# Get [http://www.codeblocks.org/ Code::Blocks] and all [[Dependencies#Installing_the_dependencies_on_Windows|libraries]].
# Check if the dlls were compressed (SDL.dll, SDL_Image.dll, SDL_Mixer.dll)
# Get [http://gnuwin32.sourceforge.net/packages/gettext.htm Gettext for windows]
# Copy msgfmt.exe and all DLL files from the directory "bin" of your gettext installation to <code>TMW/packaging/windows</code>
For each release:
# Open <code>TMW/tmw.cbp</code> with Code::Blocks and compile the project
# Run the visual basic script <code>TMW/packaging/windows/make-translations.vbs</code> to compile the gettext translation files
# Make sure <code>setup.nsi</code> mentions the right TMW version
# Run the script <code>TMW/packaging/windows/setup.nsi</code> using NSIS
# Test the installer with a fresh installation (uninstall and delete installations). Test also uninstall process to check if removes all the files.
You will now have a distributable installer in <code>TMW/packaging/windows/</code>


=== Notifying the package maintainers and websites ===
=== Notifying the package maintainers and websites ===


Normally first the source and Windows releases are made. After verifying everything works with several people for at least a day, the release will be tagged in [[Git Repository|Git]]. At that point the release is official and the package maintainers should get started on producing their package.
Normally first the source and Windows releases are made. After verifying everything works with several people for at least a day, the release will be tagged in [[Git repository|Git]]. At that point the release is official and the package maintainers should get started on producing their package.


The following people are responsible for updating their packages:
The following people are responsible for updating their packages:
Line 28: Line 49:
* '''Slackware''' - [[User:Platyna|Platyna]]
* '''Slackware''' - [[User:Platyna|Platyna]]
* '''MacOS X''' - [[User:Trapdoor|trapdoor]]
* '''MacOS X''' - [[User:Trapdoor|trapdoor]]
* '''Arch Linux''' - [[User:Bjørn|Bjørn Lindeijer]]
* '''Arch Linux''' - [http://aur.archlinux.org/packages.php?ID=9447 Package details (mark out of date)]


The following people are responsible for updating the respective websites:
The following people are responsible for updating the respective websites:


* http://freshmeat.net/ - [[User:Bjørn|Bjørn Lindeijer]]
* [http://freshmeat.net/projects/tmw/ Freshmeat] - [[User:Bjørn|Bjørn Lindeijer]]
* http://games.linux.sk/ - [[User:Bjørn|Bjørn Lindeijer]]
* [http://games.linux.sk/index.php?id=141 Games for Linux] - [[User:Bjørn|Bjørn Lindeijer]]
* http://rpgdx.net/ - [[User:Bjørn|Bjørn Lindeijer]]
* [http://packages.gentoo.org/package/games-rpg/tmw Gentoo Packages] - [[User:Bjørn|Bjørn Lindeijer]] emails [mailto:games@gentoo.org Games herd]
* http://happypenguin.org/ - ?
* [http://happypenguin.org/show?The%20Mana%20World The Linux Game Tome] - ?
* [http://packages.gentoo.org/packages/?category=games-rpg;name=tmw http://packages.gentoo.org/...] - [[User:Bjørn|Bjørn Lindeijer]] emails [mailto:games@gentoo.org Games herd]
* [http://rpgdx.net/showgame.php?project_id=297 RPGDX] - [[User:Bjørn|Bjørn Lindeijer]]


=== Creating a windows installer===
=== Updating the wiki ===


# [[Git|Clone the git repository of the eAthena client]]. The directory where you have the cloned repository will now be referred to as "TMW"
The following pages may need to be brought up to date with the new release. Anyone may update these pages, and are encouraged to do so.
# Get [http://nsis.sourceforge.net Nullsoft Scriptable Install System]
# Get [http://www.codeblocks.org/ Code::Blocks] and all [[Dependencies#Installing_the_dependencies_on_Windows|libraries]].
# Get [http://gnuwin32.sourceforge.net/packages/gettext.htm Gettext for windows]
# Get the [http://sourceforge.net/project/showfiles.php?group_id=106790&package_id=199743 music package] and put it into the TMW/data directory (so you have TMW/data/music/*.ogg)
# Open TMW/tmw.cbp with Code::Blocks and compile the project
# Copy msgfmt.exe and all DLL files from the directory "bin" of your gettext installation to TMW/packaging/windows
# Run the visual basic script TMW/packaging/windows/make-translations.vbs to compile the gettext translation files
# Run the NSIS script TMW/packaging/windows/setup.nsi using NSIS


You will now have a distributable installer in TMW/packaging/windows/
* [[Archive:Config settings|Config settings]] - default options and option names
* [http://doc.manasource.org/dependencies Dependencies] - dependencies and version
* [[Screenshots]] - a new and fresh screenshot showing off a new feature (and new content)
* [[Walkthrough]] - default controls

Latest revision as of 07:56, 5 March 2024

Updating the version and release date

The program version and release date are mentioned in several places. Some other places are also important to check before making a release.

  • CMakeLists.txt - version
  • INSTALL - dependencies and their versions
  • NEWS - version, release date and changes
  • data/help/changes.txt - version, release date and changes
  • data/help/header.txt - version and release date
  • src/main.h - version
  • src/winver.h - version
  • packaging/windows/setup.nsi - version

Making a clean tarball

Authors and packagers should work on making a clean tarball, which has no .git folders, no Makefiles, no .deps folders, etc... That kind of clean is needed when uploading sources such as for Debian, and can be obtained thanks to make dist, with automake.

To test that the distribution compiles and installs with just the files included in the release, make distcheck can be used. However, you should also make sure that it actually runs.

Creating a windows installer

First time setup:

  1. Clone the Git repository of the eAthena client. The directory where you have the cloned repository will now be referred to as "TMW"
  2. Get Nullsoft Scriptable Install System
  3. Install UPX (the script expects upx to be in a "upx" subdirectory)
  4. Get Code::Blocks and all libraries.
  5. Check if the dlls were compressed (SDL.dll, SDL_Image.dll, SDL_Mixer.dll)
  6. Get Gettext for windows
  7. Copy msgfmt.exe and all DLL files from the directory "bin" of your gettext installation to TMW/packaging/windows

For each release:

  1. Open TMW/tmw.cbp with Code::Blocks and compile the project
  2. Run the visual basic script TMW/packaging/windows/make-translations.vbs to compile the gettext translation files
  3. Make sure setup.nsi mentions the right TMW version
  4. Run the script TMW/packaging/windows/setup.nsi using NSIS
  5. Test the installer with a fresh installation (uninstall and delete installations). Test also uninstall process to check if removes all the files.

You will now have a distributable installer in TMW/packaging/windows/

Notifying the package maintainers and websites

Normally first the source and Windows releases are made. After verifying everything works with several people for at least a day, the release will be tagged in Git. At that point the release is official and the package maintainers should get started on producing their package.

The following people are responsible for updating their packages:

The following people are responsible for updating the respective websites:

Updating the wiki

The following pages may need to be brought up to date with the new release. Anyone may update these pages, and are encouraged to do so.

Retrieved from "https://oldwiki.themanaworld.org/index.php?title=Archive:Making_a_new_release&oldid=59459"