(→Set Up: added Ali-G's Development Guide + Link to README.mv.txt) |
(updated according to o11c's help) |
||
Line 25: | Line 25: | ||
* Open ~/tmw-ea/eathena-data/login/save folder. | * Open ~/tmw-ea/eathena-data/login/save folder. | ||
* Open '''account.txt.example''' and save it at the same place under '''account.txt'''. | * Open '''account.txt.example''' and save it at the same place under '''account.txt'''. | ||
* ''cd'' | |||
* ''git config --global url.git@gitorious.org:.pushInsteadOf git://gitorious.org'' | |||
* ''cd ~/tmw-ea/eathena-data/client-data'' | |||
* ''git checkout master'' | |||
* Close the terminal. | |||
You can now launch your test server. | You can now launch your test server. | ||
Line 33: | Line 38: | ||
* ''mana -u -d ~/tmw-ea/eathena-data/client-data'' | * ''mana -u -d ~/tmw-ea/eathena-data/client-data'' | ||
You are now | You are now free to do some changes, first close the client and your servers. | ||
* Make your modifications (e.g. Change a map) and save them. | |||
* Open a terminal. | |||
* ''cd ~/tmw-ea/eathena-data/client-data'' | |||
* ''git status'' | |||
* ''git add [modified files]'' | |||
* ''git commit'' | |||
* ''git push'' | |||
* ''cd ../eathena-data'' | |||
* ''make maps'' (if you changed a map) | |||
* ''git status'' | |||
* ''git add [modified files]'' | |||
* ''git commit'' | |||
* ''git push'' | |||
This should run all three of your servers. | This should run all three of your servers. | ||
Line 58: | Line 76: | ||
This has been my experience on running the java Converter tools, which takes map data from client-data and applies it to the server-data. The README addresses dependencies for using this tool. It suggests there are other ways it can work in the README, if this method does work for you. | This has been my experience on running the java Converter tools, which takes map data from client-data and applies it to the server-data. The README addresses dependencies for using this tool. It suggests there are other ways it can work in the README, if this method does work for you. | ||
# cd ~/tmw-ea/eathena-data/ | Edit your map and save it. You can push the client data now. Now, you need to run the converter. | ||
# cd ~/tmw-ea/eathena-data/ | |||
# | # make maps | ||
After that, commit and push the files that the converter edited. | |||
==Making Art Content== | ==Making Art Content== | ||
Line 93: | Line 110: | ||
[http://dl.dropbox.com/u/6520164/tester1.txt Bit Masking Test Script] | [http://dl.dropbox.com/u/6520164/tester1.txt Bit Masking Test Script] | ||
=Using the Git Repositories= | =Using the Git Repositories= | ||
==Making Git Patches | ==Making and Submitting Git Patches for Review== | ||
==Reviewing Git Patches and Pushing== | ==Reviewing Git Patches and Pushing== | ||
==Git Branches, Git Merging== | ==Git Branches, Git Merging== |
Revision as of 21:40, 25 June 2011
Set Up
This is a how to help content development for official TMW-eA using Ubuntu 10.04 on amd64 and the Mana client. Other OS and clients may differ. Following this guide, you should be able to get development testing versions of the client data (tmwdata), server-data (eathena-data) and participate in development by using a localhost server. After getting these, you can both test current development and begin development in the direction you find most fitting.
Dependencies: Throughout this tutorial, I do not address dependencies. Bison and Flex are needed, as are other dependencies. This will be inserted with time.
Set Up Own Server
Here are the steps I use all the time when I want to make a new, fresh local testing server.
- Open a terminal.
- mkdir ~/tmw-ea
- cd ~/tmw-ea/
- git clone git://gitorious.org/tmw-eathena/mainline.git eathena
- git clone --recursive git://gitorious.org/+tmw-admins/tmw/tmwa-server-test.git eathena-data
- cd eathena/
- make
- sudo cp login-server char-server map-server /usr/local/bin/
- Close terminal.
- Open ~/tmw-ea/eathena-data/login/conf folder.
- Open login_local.conf.example and save it at the same place under login_local.conf.
- Open ~/tmw-ea/eathena-data/world/conf folder.
- Open char_local.conf.example, change the 81.161.192.4 to 127.0.0.1 and save it at the same place under char_local.conf.
- Open ~/tmw-ea/eathena-data/world/map/conf folder.
- Open help.txt.example and save it at the same place under help.txt.
- Open map_local.conf.example, change the 81.161.192.4 to 127.0.0.1 and save it at the same place under map_local.conf.
- Open ~/tmw-ea/eathena-data/login/save folder.
- Open account.txt.example and save it at the same place under account.txt.
- cd
- git config --global url.git@gitorious.org:.pushInsteadOf git://gitorious.org
- cd ~/tmw-ea/eathena-data/client-data
- git checkout master
- Close the terminal.
You can now launch your test server.
- Open a terminal.
- cd ~/tmw-ea/eathena-data/
- ./char-server& ./login-server& ./map-server&
- Open another terminal.
- mana -u -d ~/tmw-ea/eathena-data/client-data
You are now free to do some changes, first close the client and your servers.
- Make your modifications (e.g. Change a map) and save them.
- Open a terminal.
- cd ~/tmw-ea/eathena-data/client-data
- git status
- git add [modified files]
- git commit
- git push
- cd ../eathena-data
- make maps (if you changed a map)
- git status
- git add [modified files]
- git commit
- git push
This should run all three of your servers.
See Also: README.mv.txt - Documentation on using git submodules, like client-data and tmw-music.
Administation
- Start the servers.
- Open a command line terminal.
- cd ~/tmw-ea/eathena-data
- ./ladmin
- add username M password
- gm username 99
Connecting
- Open a command line terminal.
- Run your client pointing to your client data and your local server. E.g. mana -u -d ~/tmw-ea/tmwdata --server localhost --port 6901
If all goes well, you are now ready to test new content and participate with development.
Making Content
Making Map Content
Java Converter Tool
This has been my experience on running the java Converter tools, which takes map data from client-data and applies it to the server-data. The README addresses dependencies for using this tool. It suggests there are other ways it can work in the README, if this method does work for you.
Edit your map and save it. You can push the client data now. Now, you need to run the converter.
- cd ~/tmw-ea/eathena-data/
- make maps
After that, commit and push the files that the converter edited.
Making Art Content
Steps
- Post [CPT] or [WIP] art on the graphics development forum.
- Work with the Art Director and collaborators on getting the art consistent.
- When finished, edit topic as [FND].
- Art Director approves [FND] art and makes/requests xml for it.
- A1. Once the .png and .xml is ready, the Art Directory can mark as [RC].
- A2. Any developer, including the Art Director, can add [RC] content through a patch, or push if they have commit access.
- A3. Once pushed, Art Director marks topic as [GIT].
- or
- B. Art Director commits art and xml, then marks as [GIT].
- Project developer requests database entry reservations from a General Content Team developer.
- Map entry server data affected: resnametable.txt and .wlk files in the data directory, map content files in the npc directory.
- Map entry client data affected: .tmx files in the maps directory.
- Map entry requires the running of the .tmx converter (aka java converter) before commits can be made.
- Art content server data affected: entry made in the item_db.txt, mob_db.txt or mob_skills_db.txt in the db directory.
- Art content client data affected: entry added in items.xml, monsters.xml or other identification file, art .png and xml added to appropriate sub-directory in the graphics directory.
Handling General Content Team [REQ]s
- General Content Team member adds a [REQ] topic to the graphics development forum.
- General Content Team member adds the [REQ] topic as a hyperlink under "Required Art" on the Art in Development page.
- Art Director attempts to network with other artists to assign the art to an artist.
Bit Masking
Bit Masking helps us reduce our variable count while offering a dynamic method of script writing that is versatile and flexible to both linear and non-linear script writing.