0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

eclipse plugin: Update the Dev manual

Browse source
This commit is contained in:
Timotei Dolean 2011-06-28 14:57:49 +00:00
parent df1fe2d2a0
commit 9842241b30
1 changed files with 37 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
utils/umc_dev/manual/dev_manual.tex
View file

@ -97,6 +97,43 @@ After you've setup the environment you can run the plugin.
\includegraphics[scale=0.7]{launch_plugin.png}
\end{center}
\section{Building the plugin}
The plugin can be built as a zip archive (usually) for different operating systems. The built application can be launched without any Eclipse prerequisites. This plugin's version is called \textbf{Standalone}. To build the plugin, you need to follow the specified steps:
\begin{enumerate}
\item Download the ``eclipse\_3.6.2.zip" archive, that contains an already existing eclipse installation and deltapack (used for building against other OSes than the native one). The link for the download is: \href{http://sourceforge.net/projects/wesnoth/files/wesnoth-umcplugin/build\_utils/eclipse\_3.6.2.zip/download}{Download}
\item Extract the archive in the favorite location
\item You now have 2 choices: Build the plugin from within Eclipse - this way you can build, say, just for your current OS/architecture - or you can use the already existing build scripts - those build the plugin for all currently supported architectures.
\item If you want to build the plugin from within Eclipse, you need to do the following steps:
\begin{enumerate}
\item Open Eclipse.
\item Go to menu: Window -$>$ Preferences-$>$ Plug-in Development-$>$ Target Platform
\item Select the \textbf{Running Platform (Active)} item and press ``Edit..." in the left buttons lane.
\item A new window with tabs will be opened. Select the ``Locations" tab, and in the right buttons lane, select ``Add..."
\item Select ``Directory" in the new windows, then press Next.
\item Browse to the previous location where you have extracted the ``eclipse\_3.6.2.zip" archive.
\item Press Finish and Ok until you exist all windows.
\item Now, go into the ``org.wesnoth" project, and open the file ``org.wesnoth.product".
\item In the bottom right part of the opened file, in section ``Exporting" there is a link: ``Eclipse Product export wizard". Click that.
\item In the ``destination" group, select where you want the export/build to be done.
\item Check the ``Generate metadata repository". You can also check ``Export for multiple platforms" if you want to build the plugin for other OSes/Architectures aswell.
\item Press Next if you have selected ``Export for multiple platforms" and select the desired OSes/Architectures.
\item Finally press ``Finish" to do the building.
\end{enumerate}
\item If you want to build the plugin using the scripts, do the following:
\begin{enumerate}
\item Go to the ``org.wesnoth.build" in the checked-out directory from the SVN.
\item There are 2 files that are important: \textbf{build.sh} - For UNIX systems - and \textbf{build.cmd} - For Windows systems.
\item Both files need a one argument that specifies the path to a valid Eclipse + deltapack installation. The file you have previously downloaded contains this.
\item You can invoke the script with the 1st parameter as the path to the location where you have extracted the archive.
\item The directory ``wesnoth\_umc\_dev" will contain now the built plugin as zip archives, while the ``update\_site" directory will contain the update site for the plugin.
\end{enumerate}
\end{enumerate}
\section{Frequently Asked Questions}
\subsection{Where can I submit any bugs found?}
Go over to Wesnoth's bug tracker: \href{https://gna.org/bugs/?func=additem&group=wesnoth&bug_group_id=116}{Add new bug}. Please be as specific as possible. Also, if you have any logs, please attach them.