document module purposes

src/actor.rs

@@ -7,6 +7,10 @@
 //   ▀████████▀ + ▀███████    ███▄   ███▄       ▀████ ▀███████
 //       +                  +                +             ███
 //  +   ▀████████████████████████████████████████████████████▀
+//
+// This module manages the internal states of individual characters,
+// such as their resources, the damage they receive, and interactions
+// between characters and with vehicles.
 
 use bevy::prelude::*;
 use bevy_xpbd_3d::prelude::*;

src/audio.rs

@@ -7,6 +7,8 @@
 //   ▀████████▀ + ▀███████    ███▄   ███▄       ▀████ ▀███████
 //       +                  +                +             ███
 //  +   ▀████████████████████████████████████████████████████▀
+//
+// This module manages sound effects and music.
 
 use bevy::prelude::*;
 use bevy::audio::{PlaybackMode, Volume};

src/camera.rs

@@ -7,6 +7,9 @@
 //   ▀████████▀ + ▀███████    ███▄   ███▄       ▀████ ▀███████
 //       +                  +                +             ███
 //  +   ▀████████████████████████████████████████████████████▀
+//
+// This module manages the game's viewport and handles camera- and
+// movement-related keyboard input.
 
 use bevy::prelude::*;
 use bevy::input::mouse::{MouseMotion, MouseWheel};

src/chat.rs

@@ -7,6 +7,9 @@
 //   ▀████████▀ + ▀███████    ███▄   ███▄       ▀████ ▀███████
 //       +                  +                +             ███
 //  +   ▀████████████████████████████████████████████████████▀
+//
+// This module loads the chat definitions from the YAML files
+// and manages the flow of conversations.
 
 use crate::{actor, audio, effects, hud, var, world};
 use bevy::prelude::*;

src/commands.rs

@@ -8,7 +8,7 @@
 //       +                  +                +             ███
 //  +   ▀████████████████████████████████████████████████████▀
 //
-// This plugin loads "defs.txt" and applies the therein contained commands
+// This module populates the world with actors as defined in "defs.txt"
 
 extern crate regex;
 use bevy::prelude::*;

src/effects.rs

@@ -7,6 +7,8 @@
 //   ▀████████▀ + ▀███████    ███▄   ███▄       ▀████ ▀███████
 //       +                  +                +             ███
 //  +   ▀████████████████████████████████████████████████████▀
+//
+// This module manages visual effects.
 
 use bevy::prelude::*;
 use crate::{camera, var};

src/hud.rs

@@ -7,6 +7,8 @@
 //   ▀████████▀ + ▀███████    ███▄   ███▄       ▀████ ▀███████
 //       +                  +                +             ███
 //  +   ▀████████████████████████████████████████████████████▀
+//
+// This module manages the heads-up display and augmented reality overlays.
 
 use crate::{actor, audio, camera, chat, nature, skeleton, var, world};
 use bevy::prelude::*;

src/main.rs

@@ -7,6 +7,9 @@
 //   ▀████████▀ + ▀███████    ███▄   ███▄       ▀████ ▀███████
 //       +                  +                +             ███
 //  +   ▀████████████████████████████████████████████████████▀
+//
+// This module initializes the game, handles command-line arguments,
+// and manages window-related key bindings.
 
 mod actor;
 mod audio;

src/nature.rs

@@ -8,9 +8,7 @@
 //       +                  +                +             ███
 //  +   ▀████████████████████████████████████████████████████▀
 //
-// This stuff here, this stuff is messy. Nobody wants to deal with this,
+// This module manages the messy, impure parts of our universe.
-// nobody cares how it works, but I guess we need it as an ingredient for
-// the universe *sigh* so here we go.
 
 pub const OXYGEN_USE_KG_PER_S: f32 = 1e-5;
 pub const OXY_S: f32 = OXYGEN_USE_KG_PER_S;

src/shading.rs

@@ -7,6 +7,8 @@
 //   ▀████████▀ + ▀███████    ███▄   ███▄       ▀████ ▀███████
 //       +                  +                +             ███
 //  +   ▀████████████████████████████████████████████████████▀
+//
+// This module manages graphics shaders.
 
 use bevy::prelude::*;
 use bevy::render::render_resource::{AsBindGroup, ShaderRef};

src/skeleton.rs

@@ -7,6 +7,8 @@
 //   ▀████████▀ + ▀███████    ███▄   ███▄       ▀████ ▀███████
 //       +                  +                +             ███
 //  +   ▀████████████████████████████████████████████████████▀
+//
+// This module manages model loading and animation.
 
 use crate::world;
 use bevy::ecs::system::EntityCommands;

src/var.rs

@@ -7,6 +7,9 @@
 //   ▀████████▀ + ▀███████    ███▄   ███▄       ▀████ ▀███████
 //       +                  +                +             ███
 //  +   ▀████████████████████████████████████████████████████▀
+//
+// This module manages variables, settings, as well as evaluating
+// "if"-conditions in chats.
 
 use bevy::prelude::*;
 use std::collections::HashMap;

src/world.rs

@@ -7,6 +7,8 @@
 //   ▀████████▀ + ▀███████    ███▄   ███▄       ▀████ ▀███████
 //       +                  +                +             ███
 //  +   ▀████████████████████████████████████████████████████▀
+//
+// This module populates the world with stars and asteroids.
 
 use crate::{actor, audio, hud, nature, shading, skeleton, var};
 use bevy::prelude::*;