Modding Guide

From Cube Wiki
Revision as of 16:59, 12 December 2014 by Admin (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

The top place to look for published mods is, of course, on Quadropolis. Use either the table or the list of available mods. Always remember -- the source is zlib license, the artwork under varying (but generally more restrictive) licenses.

Important DOs

  1. Read the license, this means every available one and check they allow you to do what you want to do. In very short: you can use the source; but any media is not distributable. Their license is soley for dot3labs to distribute with Sauerbraten (except where EXPLICITLY STATED OTHERWISE -- such as free for all non-commercial use; if there is no explicitly stated license, it is for the Sauerbraten distribution ONLY). Any derived work of yours will have to either be a "total conversion" (e.g. make models and maps from scratch with your own texture set and all) or be a "Client/Server mod" (e.g. small changes to either side of the game).
  2. You should NEVER, ever, ever, ever run these modifications on the regular network; best approach is to edit the designated ports for your mod right away and never try to register modded servers on the Sauerbraten masterserver!
  3. Read the todo list and all developer info you find lying around, it helps!
  4. Keep a list of your changes; this is incredibly important and helpful.
  5. Abide by the ZLIB license.
  6. Take screenshots of your mod periodically and compare them to the ones on the main page . Does the mod look better or worse? Don't delete these, they'll look great as thumbnails on your "changelog" page.

Top 3 DON'Ts

  1. Don't copy content (textures, maps, models, etc.) without consent by the respective copyright holder (see appropriate readme's). Inquire on forum if in doubt.
  2. Don't use the official network/port/masterserver for your mod. This means you need your own masterserver and should use different UDP ports than the regular game.
  3. Don't forget open-source is free as in free speech, not as in free beer.

See also: Building and Compiling
How not to start a mod
How to approach modding