Difference between revisions of "Development Docs"

From Armagetron
(varpasdom)
m (Update macOS link)
(46 intermediate revisions by 22 users not shown)
Line 1: Line 1:
[http://whinstone-cottages.explisit.in/ whinstone cottages] [http://prin-sabun.ibelgique.com/inari.html inari shrine] [http://jerry-seinfeld.lufberry.in/ jerry seinfeld] [http://new-ways-to.holily.in/ new ways to masturbate] [http://1x-0007.ibelgique.com/resources/book-marknet.html book mark.net mark.html] [http://latonyawelling.ifrance.com/lib/mcpherson.html mcpherson chevrolet] [http://carmagaleano.ifrance.com/topic/akrapovic.html akrapovic exhaust system] [http://demon-dance.ibelgique.com/web/free-email-accounts.html free email accounts] [http://dust-cover.lufberry.in/ dust cover] [http://danakrogman.ifrance.com/wiki/cape-cod-homes.html cape cod homes for sale] [http://marlineoreilly.ifrance.com/small/artist-xscape.html artist xscape] [http://cheerfulstoic.50webs.com/comments/mortal-kombat.html mortal kombat annihilation movie photos] [http://aero-lite.ibelgique.com/tina-turner.html tina turner] [http://brynnparkey.ifrance.com/listening-skills.html listening skills] [http://dtolstoles.isuisse.com/retro-gifts.html retro gifts] [http://cheerfulstoic.50webs.com/comments/sport-books-casinos.html betting book casino online sport] [http://ya-uza.isuisse.com/styles/rail-away.html rail away] [http://manawebster.iespana.es/view/discount-ink.html discount ink jet cartridge] [http://reoracer.50webs.com/suprise.html cream pie surprise] [http://looking-for-love.panterra.in/ looking for love] [http://schwinn-bicycle.leonis.in/ schwinn bicycle] [http://1x-0007.ibelgique.com/resources/party-pics.html party pics] [http://natural-aphrodisiac.holily.in/ natural aphrodisiac] [http://kimigassett.iespana.es/view/sidewalk-width.html sidewalk width standard] [http://manawebster.iespana.es/view/free-nude-jessica.html free nude jessica biel] [http://gallery-of-thick.kamahi.in/ gallery of thick girls] [http://traceejeffreys.ifrance.com/topic/ve-irons-inc.html v.e. irons inc] [http://karinepiatt.iespana.es/styles/zip-code-in-washington.html zip code in washington dc] [http://boy-feet.diglot.in/ boy feet] [http://matts-tar.ibelgique.com/lib/suzy-bogguss-aces.html suzy bogguss aces] [http://latonyawelling.ifrance.com/lib/rem-mp3.html rem mp3] [http://demon-dance.ibelgique.com/web/philadelphia-bars.html philadelphia bars super bowl party] [http://reganfeld.we.bs/silo-cleaning-machines.html silo cleaning machines] [http://marlynbarrios.iespana.es/resources/muncho-lake-bc.html muncho lake bc] [http://drawings-of-lowriders.explisit.in/ drawings of lowriders] [http://latonyawelling.ifrance.com/lib/effects-infection.html effects infection kidney side] [http://erlinetor.we.bs/text/overseas-dropshippers.html overseas dropshippers] [http://lettering.lufberry.in/ lettering] [http://canon-eos20d.explisit.in/ canon eos20d] [http://brynnparkey.ifrance.com/sportsmans-guide.html sportsmans guide] [http://cavalier-spaniels.lufberry.in/ cavalier spaniels for sale] [http://imp-r0.isuisse.com/topic/petite-dresses.html dress petite size] [http://apex-socket.holily.in/ apex socket] [http://cheerfulstoic.50webs.com/comments/racing-helmets.html fox racing helmet] [http://traceejeffreys.ifrance.com/topic/impact-tna.html impact tna] [http://el-estado-moderno.mainland.in/ el estado moderno] [http://live-beeez.ibelgique.com/tiny-boobs-humiliating.html tiny boobs humiliating] [http://garething.isuisse.com/new/tumeurs-cerebrales.html tumeurs cerebrales] [http://richard-foster.lufberry.in/ richard foster mckinsey] [http://cheerfulstoic.50webs.com/comments/kenny-chesny.html kenny chesny] [http://ibm-thinkpad.waunakee.in/ ibm thinkpad a21m laptop] [http://karinepiatt.iespana.es/styles/cordless-headset.html plantronics cordless headset phone] [http://reoracer.50webs.com/nudest-pictures.html nudest pictures] [http://danakrogman.ifrance.com/wiki/vespa-for-sale.html vintage vespa for sale] [http://brynnparkey.ifrance.com/javon-jackson.html javon jackson quartet] [http://katricebliss.iespana.es/article/im-too-psp-video.html im too psp video converter] [http://danakrogman.ifrance.com/wiki/plainfield-real.html estate ma plainfield real] [http://dtolstoles.isuisse.com/lollapaloozacom.html lollapalooza.com] [http://brynnparkey.ifrance.com/vacuum-pumps.html vacuum pump] [http://traceejeffreys.ifrance.com/topic/rats-on-cocaine.html rats on cocaine animation] [http://traceejeffreys.ifrance.com/topic/east-glacier.html east glacier motel cabins] [http://zench.isuisse.com/106andpark-com.html 106andpark com] [http://latonyawelling.ifrance.com/lib/marine-corps.html marine corps close combat] [http://imp-r0.isuisse.com/topic/moldavite.html moldavite starborn stone transformation] [http://yasa-shisa.isuisse.com/06-5-9-american.html 06 5 9 american idol result] [http://1x-0007.ibelgique.com/resources/under-armour-loose.html armour fit loose under] [http://tangelaflora.we.bs/olympian-propane.html olympian propane heaters] [http://aero-lite.ibelgique.com/knee-kick-balls.html knee kick balls groin] [http://romonacumberlan.iespana.es/comments/star-wars-wallpaper.html star wars wallpaper] [http://theli.isuisse.com/blog/mega-mobile-t-tone.html mega mobile t tone] [http://dtolstoles.isuisse.com/toddler-games.html free game toddler] [http://cheerfulstoic.50webs.com/comments/arlene-rodriguez.html arlene rodriguez] [http://latonyawelling.ifrance.com/lib/ireland-vacation.html ireland vacation] [http://ya-uza.isuisse.com/styles/ad-aware-60.html ad aware 6.0 free download] [http://theli.isuisse.com/blog/lightsabers.html lightsabers] [http://imp-r0.isuisse.com/topic/comparatif-assurance.html comparatif assurance vie] [http://kimigassett.iespana.es/view/christmas-gift.html christmas gift] [http://erlinetor.we.bs/text/am-referrers-site.html am referrers site top] [http://erlinetor.we.bs/text/volvo-navigation.html volvo navigation systems] [http://cocktaillounge.50webs.com/data/father-son-gay.html father son gay sex] [http://marlineoreilly.ifrance.com/small/electronic-thermostates.html electronic thermostates] [http://used-police-laptops.holily.in/ used police laptops for lease] [http://greta-pier.ibelgique.com/wiki/hall-of-the-mountain.html in the hall of the mountain king remix] [http://patty-reed-fabric.lufberry.in/ patty reed fabric] [http://romonacumberlan.iespana.es/comments/pink-wedding.html pink wedding ring] [http://conchitawoolver.iespana.es/so-happy-together.html happy so together] [http://1x-0007.ibelgique.com/resources/oil-filter-cross.html oil filter cross reference fram] [http://twanagoggin.ifrance.com/web/heavy-duty-chair.html heavy duty chair] [http://solwind.50webs.com/south-el-monte.html south el monte ca] [http://katricebliss.iespana.es/article/yahoo-groups.html yahoo group listserv] [http://lucienneespinoz.ifrance.com/comments/yahoo-messenger.html free yahoo messenger download] [http://matts-tar.ibelgique.com/lib/rucci.html rucci] [http://live-beeez.ibelgique.com/knowledge-mobility.html knowledge mobility network space system] [http://manawebster.iespana.es/view/tapi-control.html tapi control] [http://returnandremain.ibelgique.com/magazine-price.html magazine price comparison] [http://matts-tar.ibelgique.com/lib/free-card-captor.html free card captor sakura hentai] [http://matts-tar.ibelgique.com/lib/the-world-of-residensea.html the world of residensea] [http://dakot-ces.isuisse.com/toro.html toro] [http://cheerfulstoic.50webs.com/comments/oklahoma-child.html child custody in law oklahoma] [http://traceejeffreys.ifrance.com/topic/perfect-10-plays.html perfect 10 plays up women] [http://greta-pier.ibelgique.com/wiki/lever-problem.html lever problem] [http://twanagoggin.ifrance.com/web/uk-lottery.html lottery online uk] [http://danakrogman.ifrance.com/wiki/wwwsportsmansguidecom.html www.sportsmansguide.com] [http://reganfeld.we.bs/jet-set-radio.html cheat for jet set radio future] [http://reoracer.50webs.com/jean-craighead.html jean craighead] [http://live-beeez.ibelgique.com/where-you-from.html where you from playa east side playa] [http://romonacumberlan.iespana.es/comments/union-square.html union square hotel san fransisco] [http://katricebliss.iespana.es/article/sex-hot-girl.html sex hot girl] [http://morningmoon.we.bs/web/partituras-billy.html partituras billy idol] [http://marlineoreilly.ifrance.com/small/gifts-for-her.html gift her idea valentine] [http://dillon-sky.ibelgique.com/voodoo.html voodoo] [http://manawebster.iespana.es/view/blackdogue.html blackdogue] [http://j-oclama.isuisse.com/quantitative-finance.html quantitative finance careers] [http://katricebliss.iespana.es/article/sex-love.html true story of love and sex from the internet] [http://returnandremain.ibelgique.com/billiard-supplies.html billiard supplies] [http://manawebster.iespana.es/view/boston-tea-party.html information on the boston tea party] [http://solwind.50webs.com/laser-mark-stretch.html laser mark stretch surgery] [http://luannecovarrubi.iespana.es/content/mocha-cookie.html mocha cookie recipe] [http://plke.explisit.in/ plke] [http://demon-dance.ibelgique.com/web/minnesota-twins.html minnesota twins official website] [http://twanagoggin.ifrance.com/web/motley-crue-tommy.html motley crue tommy lee] [http://manawebster.iespana.es/view/tanjung-puting.html tanjung puting national park] [http://greta-pier.ibelgique.com/wiki/tarzan-and-jane.html tarzan and jane sex] [http://danakrogman.ifrance.com/wiki/mos-def-berkeley.html mos def berkeley community theater] [http://imp-r0.isuisse.com/topic/refinance-mortgage.html refinance mortgage application] [http://brynnparkey.ifrance.com/interior-designer.html interior designer] [http://zeta-jones.panterra.in/ zeta jones] [http://imp-r0.isuisse.com/topic/real-taboo-family.html real taboo family sex] [http://carmagaleano.ifrance.com/topic/water-falls.html water falls] [http://greta-pier.ibelgique.com/wiki/led-zeppelin.html led zeppelin music video] [http://lucienneespinoz.ifrance.com/comments/ludacris-mp3.html ludacris mp3] [http://erickacicero.ifrance.com/the-effect-of-substrate.html the effect of substrate concentration on enzyme action] [http://leather-journals.diglot.in/ leather journals shooting] [http://marlynbarrios.iespana.es/resources/female-condom-inserting.html female condom inserting] [http://manawebster.iespana.es/view/mortgage-jacksonville.html jacksonville loan mortgage] [http://erickacicero.ifrance.com/northern-lights.html northern lights photo gallery] [http://karinepiatt.iespana.es/styles/revenge-of-the-sith.html revenge of the sith midnight showing] [http://sony-laptop.leonis.in/ sony laptop harddrives] [http://lawnmower-repair.leonis.in/ lawnmower repair] [http://imp-r0.isuisse.com/topic/female-tattoo-galleries.html female tattoo galleries] [http://indianapolis.mainland.in/ indianapolis dinner theaters] [http://kayrouz.waunakee.in/ kayrouz] [http://karinepiatt.iespana.es/styles/st-paul-lutheran.html st paul lutheran school boca raton] [http://kimigassett.iespana.es/view/mcdonald-automotive.html mcdonald automotive group volvo ltd.] [http://yasa-shisa.isuisse.com/jojoba-oil.html jojoba oil] [http://cheerfulstoic.50webs.com/comments/new-york-islanders.html new york islanders rosters] [http://danakrogman.ifrance.com/wiki/vocal-essence.html vocal essence minneapolis] [http://erlinetor.we.bs/text/medical-manager.html medical manager sales] [http://reoracer.50webs.com/queensryche-concerts.html queensryche concerts] [http://twanagoggin.ifrance.com/web/joseph-arthur.html joseph arthur] [http://solwind.50webs.com/boy-love.html boy carpal fall love lyric tunnel] [http://j-oclama.isuisse.com/our-search-site.html our search site submit] [http://twanagoggin.ifrance.com/web/sexy-cartoon-video.html sexy cartoon video] [http://cocktaillounge.50webs.com/data/glory-hole-women.html glory hole women] [http://luannvicknair.iespana.es/parking-lot-sweeper.html parking lot vacuum sweeper] [http://romonacumberlan.iespana.es/comments/ski-utah-locals.html ski utah locals] [http://traceejeffreys.ifrance.com/topic/dd-form-1351-2.html dd form 1351-2] [http://dillon-sky.ibelgique.com/town-lake-and.html town lake and country real estate] [http://prin-sabun.ibelgique.com/pod-storage.html pod storage] [http://squirting-female.mainland.in/ squirting female orgasms] [http://godsmack-whatever.panterra.in/ godsmack whatever] [http://alexandra-paul.explisit.in/ alexandra paul] [http://luannecovarrubi.iespana.es/content/troops.html troops] [http://electronic-parts.leonis.in/ electronic parts supply] [http://luannecovarrubi.iespana.es/content/indian-actresses.html actress indian nude photo] [http://summerpica.ifrance.com/escort-female-independent.html escort female independent mumbai] [http://traceejeffreys.ifrance.com/topic/little-black-box.html little black box automobile] [http://yasa-shisa.isuisse.com/brazil-beaches.html kid brazil beach] [http://pen-making-kits.holily.in/ pen making kits uk] [http://erickacicero.ifrance.com/winston-cup-racing.html winston cup racing] [http://dakot-ces.isuisse.com/act-estate-real.html act estate real sherman virginia] [http://romonacumberlan.iespana.es/comments/marge-simpson.html marge simpson with breast implant] [http://summerpica.ifrance.com/john-deere-stationary.html deere engine john stationary] [http://inuyashachibi.50webs.com/personal-injury.html angeles attorney injury los personal] [http://dtolstoles.isuisse.com/talent-management.html talent management solution] [http://dtolstoles.isuisse.com/tabitha-stevens.html tabitha stevens nude] [http://matts-tar.ibelgique.com/lib/lost-gardens-heligan.html lost gardens heligan] [http://conchitawoolver.iespana.es/mustang-hid.html mustang hid] [http://conchitawoolver.iespana.es/xyience.html girl pic xyience] [http://latonyawelling.ifrance.com/lib/nissan-vehicles.html nissan vehicles] [http://erlinetor.we.bs/text/loch-ness.html loch ness monster pic] [http://morningmoon.we.bs/web/real-estate-for.html real estate for sale in jamaica west indies] [http://lucienneespinoz.ifrance.com/comments/systems-requirements.html systems requirements analysis] [http://morningmoon.we.bs/web/wedding-plan-list.html wedding plan list] [http://romonacumberlan.iespana.es/comments/taxi.html taxi] [http://latonyawelling.ifrance.com/lib/seminal-vesicles.html pathology prostate seminal surgical vesicles] [http://greta-pier.ibelgique.com/wiki/orient-beachcom.html orient beach.com] [http://latonyawelling.ifrance.com/lib/telephoto-lens.html telephoto lens for digital] [http://latonyawelling.ifrance.com/lib/analysis.html analysis] [http://cheerfulstoic.50webs.com/comments/billy-herrington.html billy herrington] [http://dillon-sky.ibelgique.com/the-other-cheek.html the other cheek] [http://erickacicero.ifrance.com/seattle-parks.html seattle parks and recreations] [http://summerpica.ifrance.com/2-codec-mpeg-pack.html 2 codec mpeg pack window] [http://seacoast-inn-of.explisit.in/ seacoast inn of imperial beach] [http://manawebster.iespana.es/view/painting-kitchen.html painting kitchen cabinets] [http://reganfeld.we.bs/free-twisty-girls.html free twisty girls] [http://summerpica.ifrance.com/option-arm-program.html option arm program] [http://katricebliss.iespana.es/article/canning-recipes.html canning recipes] [http://manawebster.iespana.es/view/montana-elk-hunts.html archery elk hunts montana] [http://latonyawelling.ifrance.com/lib/llanta-coche.html llanta coche]
 
 
{{Sections}} <!-- Template:Sections should be at the top of each section -->
 
{{Sections}} <!-- Template:Sections should be at the top of each section -->
  
Line 7: Line 6:
  
 
* [[Wiki Structuring Project]]
 
* [[Wiki Structuring Project]]
 +
* [[Wiki Development Project]]
  
 
== Building the Game ==
 
== Building the Game ==
Line 20: Line 20:
  
 
* [[Windows Development]]
 
* [[Windows Development]]
* Linux
+
* [[Linux Development]]
* Mac OS X
+
* [[macOS]]
 
 
todo: the linux and mac os x pages
 
  
 
== Other useful hacker documentation ==
 
== Other useful hacker documentation ==
  
 
* [[Windows Development System]]
 
* [[Windows Development System]]
* [[Working with SVN]]
 
 
* [[Cross-compiler]]
 
* [[Cross-compiler]]
 
* [[Used Libraries]]
 
* [[Used Libraries]]
 +
* [http://wrtlprnft.ath.cx/doxy/html/ Doxy]
 +
* [https://blueprints.launchpad.net/armagetronad Blueprints on launchpad]
 +
* [http://forums3.armagetronad.net/viewtopic.php?p=263866#p263866 Video tutorials on building sty+ct on Windows]
 +
 +
== Source Control ==
 +
 +
* [[Working with SVN]]
 +
* [[Bazaar]] and how we use it
 
* [[Working with SVK]]
 
* [[Working with SVK]]
* [http://wrtlprnft.ath.cx/doxy/html/ Doxy]
 
  
 
== Stuff That's Current ==
 
== Stuff That's Current ==
Line 43: Line 47:
 
* [[Adding a buildslave]]
 
* [[Adding a buildslave]]
  
== Stuff in SVN HEAD ==
+
== Stuff in SVN/BZR HEAD ==
  
 +
* [[Authentication]] -> [[Hash Based Authentication]]
 +
** [[Web Authentication]]
 
* [[Embedded Web Server]]
 
* [[Embedded Web Server]]
 
* [[Map/Config Rotation]]
 
* [[Map/Config Rotation]]
Line 52: Line 58:
 
* [[Spawn points]]
 
* [[Spawn points]]
 
* [[Zones v2]]
 
* [[Zones v2]]
 
 
* [[Cockpit Tutorial]] | [[Cockpits list]]
 
* [[Cockpit Tutorial]] | [[Cockpits list]]
 
* [[vValue]]
 
* [[vValue]]
 +
 +
== Stuff that's in branches ==
 +
 +
* [[Scripted GUI Notes]] -> [[eEvent]]
 +
** [[eEvent Resource]]
 +
* [[Modules]] (personal branch)
 +
* [[CMake]]
  
 
== Data File Handling ==
 
== Data File Handling ==
Line 66: Line 78:
 
* [[Experimental Map Features]]
 
* [[Experimental Map Features]]
 
* [[Send DTD on the resource repository through ssh]]&mdash;only of interest for people on the development team
 
* [[Send DTD on the resource repository through ssh]]&mdash;only of interest for people on the development team
 +
* [[XML Network Message]]/protobuf
  
 
== Wishlist, or Stuff that's planned ==
 
== Wishlist, or Stuff that's planned ==
Line 72: Line 85:
  
 
* [[Goals]]
 
* [[Goals]]
* [[Scripted GUI Notes]]
+
* [[Chroot build environment]]
* [[Authentication]]
 
 
* [http://forums.armagetronad.net/viewtopic.php?t=986 Reshaping the Arena]
 
* [http://forums.armagetronad.net/viewtopic.php?t=986 Reshaping the Arena]
 
* [http://forums.armagetronad.net/viewtopic.php?t=1742 Map format]
 
* [http://forums.armagetronad.net/viewtopic.php?t=1742 Map format]

Revision as of 06:17, 14 February 2021


Sections: Installing the Game | Playing the Game | Competition Hub | Server Administration | Extending Armagetron Advanced | Development Docs


This is documentation for developers or for people who just want to hack on the code. It is not intended to replace the automatic API documentation generated by doxygen (we do have a doxyfile, right?), but is intended to supplement those documents with additional information that may not necessarily appear in the API docs. It is also not intended as a substitute for good commenting tactics. And finally, it is a place to put planning documentation (like the stuff Philippe writes), proposals, RFC-type material, and so forth. But not the roadmap, we use Sourceforge's tracker for that.

Documentation

Building the Game

Building Armagetron Advanced boils down to 4 basic steps. The steps themselves are each highly platform-dependent, but the four steps are the same everywhere. Each step differs further in whether or not you're building from a branch or the trunk, and each branch may differ. Finally, each step differs depending on if you're building a source release or from version control. Here we'll concern ourselves with building the trunk only. Releases should include their own build instructions.

  1. Install the development environment
  2. Satisfy dependencies
  3. Unpackage source/source checkout from version control
  4. Build a distribution

Platform-specific instructions (they should all follow the four step structure given, that's why it's there!):

Other useful hacker documentation

Source Control

Stuff That's Current

Stuff in SVN/BZR HEAD

Stuff that's in branches

Data File Handling

Stuff That's Real but doesn't fit above

Wishlist, or Stuff that's planned

(Might not be planned, but this is it)

History

This is stuff that's of historical significance to the project. It's very difficult to remember where you're going if you don't remember where you came from, right? This is technical stuff. Community history should have its own section.


Sections: Installing the Game | Playing the Game | Competition Hub | Server Administration | Extending Armagetron Advanced | Development Docs


Information about the current Armagetron Advanced Development. How to compile the game or current working in progress.