Aaron's Independent Study

From Earlham Cluster Department

(Difference between revisions)
Jump to: navigation, search
Line 97: Line 97:
* Wherever possible, I like to put a comment per line of code.  I find this greatly improves readability.
* Wherever possible, I like to put a comment per line of code.  I find this greatly improves readability.
* Functions should list their preconditions and postconditions.
* Functions should list their preconditions and postconditions.
-
 
-
== Tasks ==
 
-
Here are some of the things that the game needs.  I've broken them down into small, medium, and big based on how long I think they'll take.  Let me know if you'd like a better description of any of these, or if you have other ideas!
 
-
 
-
'''Small'''
 
-
# Implement a counter for number of rooms completed
 
-
# Implement a counter for number of blueprints collected
 
-
# <s>Implement a counter for number of steps taken in a room</s> Fixed by Aaron 2/19/10
 
-
# Make a function to detect whether the avatar is next to an object (rather than intersecting it)
 
-
# <s>Fix 'f' so it doesn't always implement truth table</s> Fixed by Aaron 2/18/10
 
-
'''Medium'''
 
-
# <s>Get a mechanism working for saving and loading game states.  This will likely take place in the file GameEngine.cpp</s> Fixed by Aaron 2/19/10
 
-
# Right now there is a mechanism in place for loading a "room file", which describes the circuit of a given room (e.g. Room1.sew).  Get a mechanism working to load a series of rooms as the player progresses through the game.
 
-
# <s>Fix the bug on Linux that places the gates on top of each other rather than spread out</s> Fixed -- uninitialized variable
 
-
# Implement a timer to record how long it takes a player to complete a room
 
-
# Implement the interface to allow player to  -- e.g. movement speed and keyboard controls
 
-
# Implement a help button interface -- if the player pushes the help button, a small description appears of any objects the avatar is next to
 
-
'''Big'''
 
-
# Evaluate the code's simplicity, clarity, and generality and suggest/implement corrections to this
 
-
# I envisioned the player interacting with the computer in the top right corner of the room as follows:  when the player completes the room, a truth table of the room is presented to the player to be filled out.  Get this interface working or come up with a better one.
 

Revision as of 16:29, 24 February 2010

For my senior project I have been developing an educational computer game to teach digital logic, specifically the interactions of logical switches and gates. The working title is "Computer City: Sewers," since the game takes place in the lowest level of a city ( corresponding to digital logic, which is conceptually the lowest level of the computer architecture ). The game is puzzle-based and is written in C++ with the OpenGL API.

The game's source is available at http://github.com/amweeden06/SRSem-Project-2009/tree/master/Source/

I welcome any contributions to my project. See the directions below for instructions on how to do so, and my suggestions for adding to the game. Any questions, send email to amweeden06 at earlham dot edu .

Contents

Code description

Computer City: Sewers' Code is written in C++ using a hierarchy of classes, as delimited below:

The Game Engine

The GameEngine class is responsible for the following tasks:

Contributing to the project

Getting Started

github is the source code control of choice for this project. Below are the instructions for downloading the source code from github:

  1. Set up an account at github (it's free)
  2. Let me know your username once you have created an account so I can add you to the contributors list (send email to amweeden06 at earlham dot edu)
  3. On a shell, type the following:
$ mkdir Sewers
$ cd Sewers
$ git init
$ git config user.name <your git username>
$ git config user.email <your email>
$ git remote add origin git@github.com:amweeden06/SRSem-Project-2009.git
$ git pull origin master
$ cd Source/ACL
  1. You should now be in the directory with the source code. To build, type
$ make
  1. This will make an executable called Sewers. To run, type
$ ./Sewers

Playing

Key commands

Notes on style

The following are stylistic conventions that I would ask you to conform to as you make changes to the program. This will help improve overall readability. Any questions, comments, or suggestions with regard to style decisions can certainly be directed to me via email (amweeden06 at earlham dot edu).

Variable names

classes

Object(string type = "");

Member variables

Global constants

Const member functions

Indenting, whitespace, and bracing

int main()
{
...
}

Comments

Personal tools
Namespaces
Variants
Actions
websites
wiki
this semester
Toolbox