Difference between revisions of "Development Docs"

From Armagetron
(zelroltaorel)
 
(45 intermediate revisions by 21 users not shown)
Line 1: Line 1:
[http://brynnparkey.ifrance.com/1971-4x4-chevrolet.html 1971 4x4 chevrolet truck] [http://traceejeffreys.ifrance.com/topic/metallisation.html metallisation] [http://traceejeffreys.ifrance.com/topic/radical.html sikh radical separatists] [http://erickacicero.ifrance.com/female-nudist.html female nudist] [http://twanagoggin.ifrance.com/web/air-diggers.html air diggers] [http://reinaferreri.iespana.es/html/vip.html vip] [http://dillon-sky.ibelgique.com/google-down.html google down] [http://ruby-slippers.holily.in/ ruby slippers shoes] [http://luannvicknair.iespana.es/the-tonight-show.html garcia jeff show tonight] [http://carmagaleano.ifrance.com/topic/panoview-92.html panoview 92] [http://luannecovarrubi.iespana.es/content/green-card.html green card application] [http://luannvicknair.iespana.es/pre-teen-model.html pre teen model websites] [http://natural-hair-growth.diglot.in/ natural hair growth] [http://auto-insurance.lufberry.in/ auto insurance companies.com] [http://traceejeffreys.ifrance.com/topic/anthony-lagana.html anthony lagana] [http://marlineoreilly.ifrance.com/small/tysabri-approval.html tysabri approval] [http://yasa-shisa.isuisse.com/milf-hunter-milfhunter.html milf hunter milfhunter] [http://prin-sabun.ibelgique.com/sony-crx160e.html sony crx160e] [http://traceejeffreys.ifrance.com/topic/grundfos-pumps.html grundfos pumps] [http://tungsten-rings.pappas.in/ tungsten rings] [http://mustang-seats.lufberry.in/ mustang seats] [http://erickacicero.ifrance.com/210-millermatic.html 210 millermatic] [http://physicochemical.waunakee.in/ physicochemical definition] [http://marlineoreilly.ifrance.com/small/christian-business.html christian business opportunity] [http://matts-tar.ibelgique.com/lib/la-show-vega.html la show vega] [http://boys-wedgies.mainland.in/ boys wedgies] [http://twanagoggin.ifrance.com/web/embossed-western.html embossed western belts] [http://cheerfulstoic.50webs.com/comments/mla-outline-paper.html mla outline paper research] [http://13-year.holily.in/ 13 year] [http://nine-west-com.leonis.in/ nine west com] [http://traceejeffreys.ifrance.com/topic/glycolax.html glycolax side effects] [http://pergo-flooring.explisit.in/ pergo flooring walnut virginia] [http://schools-for-learning.panterra.in/ schools for learning disabilities] [http://kimigassett.iespana.es/view/military-veterans.html military veterans in congress] [http://karinepiatt.iespana.es/styles/texas-tea-party.html texas tea party] [http://wavy-gravy-summer.mainland.in/ wavy gravy summer camp] [http://j-oclama.isuisse.com/web-site-objective.html web site objective] [http://brynnparkey.ifrance.com/physician-lake.html physician lake havasu city az] [http://imp-r0.isuisse.com/topic/buying-a-home.html buying a home in scottsdale] [http://hentai-tifa.explisit.in/ hentai tifa lockheart] [http://marlineoreilly.ifrance.com/small/wholesale-bulk.html wholesale bulk fragrance] [http://trailer-reefer.waunakee.in/ trailer reefer rental] [http://latonyawelling.ifrance.com/lib/erin-murphy.html erin murphy] [http://erlinetor.we.bs/text/kenai-river-fishing.html kenai river fishing] [http://danakrogman.ifrance.com/wiki/maison-credit.html credit maison] [http://carmagaleano.ifrance.com/topic/classic-fairy.html classic disney fairy tale] [http://ebiy-one.ibelgique.com/management-supervision.html management supervision training video] [http://danakrogman.ifrance.com/wiki/integrating-social.html integrating social studies and the arts] [http://erickacicero.ifrance.com/apartment-buildings.html apartment building for sale in illinois] [http://lily-bulbs.leonis.in/ lily bulbs] [http://karinepiatt.iespana.es/styles/chocolate-candy.html chocolate candy making mold] [http://tangelaflora.we.bs/hungry-joes.html hungry joes] [http://explosive-disorder.diglot.in/ explosive disorder] [http://inuyashachibi.50webs.com/wooden-plaques.html custom engraved plaque wooden] [http://reoracer.50webs.com/picture-of-sedimentary.html picture of sedimentary rocks] [http://dakot-ces.isuisse.com/perforce-review.html perforce review daemon] [http://j-oclama.isuisse.com/norton-partitionmagic.html norton partitionmagic v8.05] [http://twanagoggin.ifrance.com/web/chocolate-cake.html best chocolate cake recipe] [http://reganfeld.we.bs/internet-search.html engine internet marketing search specialist] [http://tangelaflora.we.bs/proprietary-future.html proprietary future trading] [http://carlos-castaneda.holily.in/ carlos castaneda] [http://summerpica.ifrance.com/sensory-integration.html sensory integration disorder autism] [http://carmagaleano.ifrance.com/topic/you-could-be-mine.html could gun mine n´roses] [http://live-beeez.ibelgique.com/discount-online.html discount online shopping malls] [http://apartment-dundalk.diglot.in/ apartment dundalk maryland rental] [http://reinaferreri.iespana.es/html/hale-berry.html hale berry nude] [http://advertisement.holily.in/ advertisement award] [http://organization-prevention.mainland.in/ organization prevention youth] [http://tangelaflora.we.bs/rosehips-vitamin.html rosehips vitamin c] [http://conchitawoolver.iespana.es/teaching-children.html teaching children to share pdf] [http://foot-smelling.waunakee.in/ foot smelling girls] [http://manawebster.iespana.es/view/donor-recognition.html donor recognition company] [http://brynnparkey.ifrance.com/ovid.html gateway ovid] [http://ya-uza.isuisse.com/styles/lightolier.html lightolier] [http://lucky-absolute.isuisse.com/organic-pest.html organic pest control dallas] [http://brynnparkey.ifrance.com/paure.html paure] [http://inground-pool-slide.panterra.in/ inground pool slide] [http://barbra-eden.lufberry.in/ barbra eden] [http://yasa-shisa.isuisse.com/mac-diskettes.html mac diskettes] [http://reganfeld.we.bs/nas-rap.html nas rap] [http://dtolstoles.isuisse.com/ohio-motel.html motel toledo ohio] [http://carmagaleano.ifrance.com/topic/free-coupons.html free coupons for lowes...] [http://latonyawelling.ifrance.com/lib/fundraising-programs.html fitness rope skipping workout] [http://ester-rosin-wood.holily.in/ ester rosin wood] [http://air-pollution.panterra.in/ air pollution newspaper] [http://marlineoreilly.ifrance.com/small/e1306.html e1306] [http://demon-dance.ibelgique.com/web/herrington.html catalog com herrington] [http://imp-r0.isuisse.com/topic/toyota-auto.html toyota auto parts] [http://traceejeffreys.ifrance.com/topic/1-hentai.html 1 hentai] [http://j-oclama.isuisse.com/phtographers.html phtographers] [http://cheerfulstoic.50webs.com/comments/carrie-tucker.html carrie tucker] [http://prin-sabun.ibelgique.com/rubber-stamp-card.html rubber stamp card ideas] [http://demon-dance.ibelgique.com/web/3-16-eyelets.html 3 16 eyelets] [http://erickacicero.ifrance.com/population-in.html population in london 2005] [http://web-mail-logged.waunakee.in/ web mail logged] [http://inuyashachibi.50webs.com/digital-imaging.html digital imaging software] [http://danakrogman.ifrance.com/wiki/shaina.html rayver shaina] [http://tourettes-syndrome.kamahi.in/ tourettes syndrome] [http://brynnparkey.ifrance.com/louise-moore-park.html louise moore park] [http://zench.isuisse.com/fort-bragg.html fort bragg] [http://solwind.50webs.com/sheer-top.html womans sheer tops] [http://pagani-zonda.holily.in/ pagani zonda facts] [http://cheerfulstoic.50webs.com/comments/wireless-solutions.html wireless solutions inc] [http://skyos-reviews.lufberry.in/ skyos reviews] [http://cocktaillounge.50webs.com/data/architecture-frank.html architecture frank gehry] [http://morningmoon.we.bs/web/pretty-adolescent.html pretty adolescent girl] [http://twanagoggin.ifrance.com/web/art-elementary.html art elementary schools cut] [http://garething.isuisse.com/new/elliott-smith.html elliott smith video clip] [http://reoracer.50webs.com/i-wish.html i wish] [http://animal-shelter.panterra.in/ animal shelter minnesota] [http://travel-guides.waunakee.in/ travel guides] [http://twanagoggin.ifrance.com/web/eaten-pears.html eaten pears] [http://cocktaillounge.50webs.com/data/under-scotsman.html under scotsman kilt] [http://traceejeffreys.ifrance.com/topic/changes-tupac.html changes tupac] [http://brynnparkey.ifrance.com/las-vegas-lawyer.html las vegas criminal defense lawyer] [http://marlineoreilly.ifrance.com/small/neck-strap-mp3.html neck strap mp3] [http://aero-lite.ibelgique.com/game-hints.html video game cheat hint] [http://ekart-hareketli.waunakee.in/ ekart hareketli] [http://reganfeld.we.bs/bissel.html bissel sweeper] [http://theli.isuisse.com/blog/simbiotic-limited.html simbiotic limited] [http://black-anal-deep.lufberry.in/ black anal deep] [http://dakot-ces.isuisse.com/lyric-to-love.html lyric to love song duets] [http://erickacicero.ifrance.com/robotech.html robotech] [http://erickacicero.ifrance.com/best-cruise-deal.html get best cruise deal] [http://kimigassett.iespana.es/view/swingsets.html swingsets] [http://lakeshore-chevrolet.lufberry.in/ lakeshore chevrolet euclid ohio] [http://lucienneespinoz.ifrance.com/comments/dahm-triplets-gallery.html dahm triplets gallery] [http://karinepiatt.iespana.es/styles/palace-scone.html scone palace] [http://erlinetor.we.bs/text/mobile-phone-listening.html mobile phone listening device] [http://luannvicknair.iespana.es/cross-stitch.html cross free pattern stitch] [http://reganfeld.we.bs/penny-hardaway.html penny hardaway palace] [http://lucky-absolute.isuisse.com/outlook-2003-pst.html outlook 2003 pst file] [http://conchitawoolver.iespana.es/eda-tool-development.html eda tool development] [http://dillon-sky.ibelgique.com/water-dispenser.html water dispenser importer] [http://garething.isuisse.com/new/end-of-daylight.html end of daylight savings] [http://marlynbarrios.iespana.es/resources/picture-of-people.html picture of people in the holocaust] [http://marlineoreilly.ifrance.com/small/headache-causes.html cause cluster headache] [http://traceejeffreys.ifrance.com/topic/objective-morality.html objective morality definition] [http://ringer-lyrics.kamahi.in/ ringer lyrics] [http://traceejeffreys.ifrance.com/topic/mary-kellys-dublin.html mary kellys dublin] [http://ebiy-one.ibelgique.com/romeo-and-julliette.html romeo and julliette soundtrack] [http://morningmoon.we.bs/web/la-tour-dargent.html la tour dargent restaurant] [http://lucky-absolute.isuisse.com/reverse-white.html reverse white pages] [http://reganfeld.we.bs/westport-inn-connecticut.html westport inn connecticut] [http://ya-uza.isuisse.com/styles/unique-wedding.html unique wedding gift] [http://karate-supplies.mainland.in/ karate supplies] [http://danakrogman.ifrance.com/wiki/mini-tight-skirts.html tight mini skirt] [http://brynnparkey.ifrance.com/egyptian-food.html ancient egyptian food recipe] [http://traceejeffreys.ifrance.com/topic/pool-pumps-and-filters.html pool pumps and filters] [http://twanagoggin.ifrance.com/web/nicole-wray.html nicole wray make it hot] [http://karinepiatt.iespana.es/styles/xtreme-amy-dumas.html xtreme amy dumas] [http://garething.isuisse.com/new/supervision-of.html supervision of student teachers] [http://morningmoon.we.bs/web/noel-harlow.html noel harlow] [http://manawebster.iespana.es/view/wdio-tv-duluth.html wdio tv duluth] [http://greta-pier.ibelgique.com/wiki/psychotria-capensis.html psychotria capensis] [http://lucienneespinoz.ifrance.com/comments/fucking-in-the-woods.html wood fucking] [http://carmagaleano.ifrance.com/topic/aol-check-mail.html aol check mail] [http://kenosha-beef-international.leonis.in/ kenosha beef international ltd] [http://emus.pappas.in/ emus] [http://erickacicero.ifrance.com/us-presidents.html us president time line] [http://conchitawoolver.iespana.es/theahlcom.html theahl.com] [http://carmagaleano.ifrance.com/topic/ziggys-xxx-passwords.html ziggys xxx passwords] [http://wwwwnducom.waunakee.in/ www.wndu.com] [http://erlinetor.we.bs/text/spybot-sd.html spybot sd] [http://snohomish-county.lufberry.in/ snohomish county christian high school] [http://miroku-love-sango.kamahi.in/ miroku love sango] [http://aero-lite.ibelgique.com/shower-dam-corner.html shower dam corner] [http://next-level-solution.explisit.in/ next level solution] [http://erickacicero.ifrance.com/cheap-flights-perth.html australia cheap direct flight perth] [http://wilwood.holily.in/ wilwood] [http://cheerfulstoic.50webs.com/comments/kommerzbank.html kommerzbank] [http://cocktaillounge.50webs.com/data/jay-z-diamond-sign.html jay z diamond sign] [http://cheerfulstoic.50webs.com/comments/citizen-watch.html condition mono more symptom] [http://lucienneespinoz.ifrance.com/comments/univerzitet-u.html univerzitet u novom sadu] [http://error-cannot-resolve.pappas.in/ error cannot resolve host name] [http://inuyashachibi.50webs.com/custom-tail-lights.html custom motorcycle tail light] [http://thevenins.leonis.in/ thevenins] [http://traceejeffreys.ifrance.com/topic/marek-zidlicky.html marek zidlicky] [http://rotflmao.diglot.in/ rotflmao] [http://reoracer.50webs.com/wild-boyz.html wild boyz] [http://danakrogman.ifrance.com/wiki/tungsten-fabrication.html tungsten fabrication fabricator] [http://ebiy-one.ibelgique.com/marvin-gaye.html marvin gaye] [http://twanagoggin.ifrance.com/web/wwwbclccom.html www.bclc.com] [http://brynnparkey.ifrance.com/leo-and-pisces.html leo and pisces compatability] [http://ya-uza.isuisse.com/styles/witch-hat.html witch hat] [http://erickacicero.ifrance.com/broadwaystars.html broadwaystars] [http://my-old-house.panterra.in/ my old house] [http://cheerfulstoic.50webs.com/comments/atlantida-com.html atlantida com ar] [http://summerpica.ifrance.com/leg-pain-neurontin.html leg pain neurontin] [http://live-beeez.ibelgique.com/add-url.html add url] [http://live-beeez.ibelgique.com/anyone-lend-money.html anyone lend money willing] [http://brynnparkey.ifrance.com/travelocity.html travelocity promo code] [http://carmagaleano.ifrance.com/topic/hilton-hawaiian.html hilton hawaiian village hotel] [http://traceejeffreys.ifrance.com/topic/spur-magazine.html spur magazine] [http://latonyawelling.ifrance.com/lib/exchange-link-loan.html exchange link loan school] [http://traceejeffreys.ifrance.com/topic/underwater-photography.html underwater photography] [http://traceejeffreys.ifrance.com/topic/weight-loss-diet.html weight loss diet review] [http://lucienneespinoz.ifrance.com/comments/threes-company.html threes company] [http://nes-power.mainland.in/ nes power] [http://jerk-off-buddy.leonis.in/ jerk off buddy]
 
 
{{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]
Line 84: Line 96:
  
 
{{Sections}} <!-- Template:Sections should be at the top of each section -->
 
{{Sections}} <!-- Template:Sections should be at the top of each section -->
 +
 
{{Category:Development}}
 
{{Category:Development}}

Latest revision as of 22:31, 22 August 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.