reference.md

RealmCrafter: Community Edition Documentation

The following is a list of all the modules used by Realm Crafter, followed by a list of which modules are used by the client and the server. Click any module name to see the full documentation for its code.

List of all modules:

• AccountsServer
  Contains functions to create and manage user accounts on the server, and the accounts window.
• GameServer
  Contains functions to update the state of all game logic on the server, and to create and manage the server game window.
• UpdatesServer
  Contains functions to create and manage the server updates window, and to load update files information from disk.
• Actors
  Contains functions to create, update, save, and delete actor templates and instances, which are the people - both human and AI controlled - of the game world.
• Actors3D
  Contains functions relating to the creation, management and deletion of all client side 3D rendering data for actor instances.
• Animations
  Contains functions to load animation set data, apply it to actors, and save it back to disk.
• CharacterEditorLoader
  Contains the function to load special 3D rendering data for actors created using the Character Editor tool.
• ClientAreas
  Contains functions to load, save, and delete client side zone data.
• ClientCombat
  Contains functions to load combat settings, update the combat interface, perform combat animations on actor instances, and display combat damage.
• ClientLoaders
  Contains functions to load client side data, such as host names, game options, sky spheres and the user interface.
• ClientNet
  Contains the function to connect to the server, and the function to process all received network messages and send player updates to the server.
• Environment
  Contains functions to load, save, and manage game environment settings, such as the time of day and weather.
• Environment3D
  Contains functions to load and update 3D rendering data for the game environment, such as rain/snow, suns, and 3D weather sound effects.
• Gooey
  Custom resolution independent user interface library, used for most of the in-game interface.
• Gooey_3D_Text
  Contains functions to render text in a 3D environment for the Gooey module (see above).
• Interface
  Contains functions to load and save positioning data for the in-game interface and other related settings.
• Interface3D
  Contains functions to load and update the actual in-game interface components, and to manage all player input.
• Inventories
  Contains functions to manage the inventories of actor instances.
• Items
  Contains functions to load, save, and manage the items which actor instances can carry and use in the game.
• Language
  Loads and provides access to all string constants from a text file, to assist localisation of Realm Crafter games.
• Logging
  Contains functions to create and write to log files.
• MainMenu
  Runs the main menu on client startup.
• MD5
  Contains a function to return the MD5 checksum of a string.
• Media
  Contains functions to manage the media databases, which contain information about mesh, texture, sound and music files.
• MediaDialogs
  Provides a set of standard dialogs to allow the user to choose files from the media databases in a FUI application.
• MySQL
  Provides MySQL functionality for the server.
• Packets
  Contains a set of constants defining the various packet types for network messages.
• Projectiles
  Contains functions to load, save, and update projectiles and projectile settings.
• Projectiles3D
  Contains functions to create and update client side 3D rendering data for projectile instances.
• Radar
  Contains functions to create and update the in-game mini-map.
• RCTrees
  Contains functions to load and update trees created in the Tree Editor tool.
• RottNet
  This is the network library used by Realm Crafter, which sets up and manages network connections, and sends/receives all network messages.
• RottParticles
  Contains functions to create, load, save, and update 3D particle effects.
• Scripting
  The scripting interpreter which loads and runs user-created scripts on the server.
• ServerAreas
  Contains functions to load, save, and delete server side zone data. It also contains a function to update the current weather in a zone.
• ServerNet
  Processes all received network messages and sends updates to all connected clients.
• Spells
  Contains functions to create, load, and save ability data. Abilities are scripted powers which can be used by actor instances.

Module usage:

• Server

• RottNet

• Environment

• Items

• Projectiles

• Spells

• Actors

• Inventories

• ServerAreas

• Scripting

• Logging

• AccountsServer

• GameServer

• UpdatesServer

• Packets

• ServerNet

• MySQL

• Client

• Language

• RottParticles

• RottNet

• Media

• Environment

• Environment3D

• Animations

• Spells

• Items

• Inventories

• Actors

• Actors3D

• ClientCombat

• Interface

• Interface3D

• Radar

• RCTrees

• ClientAreas

• Logging

• ClientLoaders

• ClientNet

• MainMenu

• Packets

• Gooey

• MD5

• Projectiles3D