Reversi Project 2.4.4

Class & Function Document

Index

[toc]

How to play(command manual)

• Main Command

  Well, help must be the most useful and important command.

• Other Commands

  Why not calling help for help?

  command	arguments	effect
  help/man		help
  quit		quit
  switch to/goto	board NO	switch to the desired board
  move	row-first position (e.g. 3D)	place piece at [position]
  create board	[mode: reversi/peace] ([column size] [row size])	create new board
  list/ls	([mode: reversi/peace/current])	list the boards.
  demo	path	load demo from a file
  	you can omit move or switch to	whatever you aim at

Core Design:

Using the MVC structure and interfaces to decouple the view, game and user interface.

Controllers:

• Initialization Controller

  Initialize boards, including Input guide.

  set starting boards and player names

• Game Controller

  Controls the interactions with multiple boards.

• Input Controller

  Handles user inputs and parse instructions for the game controller.

• Settlement Controller

  Show the final result.

Board, Pieces, and Rules:

• Rules

  Rule is an interface of a general set of rules that varies among games.

• Pieces

  Piece is changed to an interface to fit more chess games, perhaps.

• Board

  Board is set as a general type that fits almost all chess games with only black and white pieces.

  Can be constructed by BoardFactory

View

• Window

  Window is the view buffer of an entity.

  It allows overlap and will clear the screen before paint.

• View

  view is an area in the window, it can't overlap and is the unit for painting.

  All painting missions should only use view.

  All painting operations will not change the corresponding views in the same window, that means, they will stay the same while the chosen view is updated.

• Screen

  screen is a final paint unit of the whole project.

  All painting operations will finally affect the Screen and shown by Screen

Update Record

V2.0.1

Rewrite the game in java.

The C version is not available since I don't want to publish that.

V2.1.1

Add Screen class to manage the whole window paint process. Preparing for the coming version featuring multiple games shown at the same time.

V2.1.2

Add multi-board feature, fixed occupation error and other bugs.

V2.1.3

Fix some spelling mistakes. Add more comments.

V2.2.0

Refactored the project to decouple.

V2.2.1

Turn all confusing coordinates into Point

V2.3.0

Use BoardFactory to initialize boards.

Enables more functions.

Use command-based input style.

V2.3.1

Fixed the bug that all draw matches will be taken as black win.

V2.4.0

Added game list on the right.

Added align mode setter.

Added short version command.

Initialization changed to fit the requirements

V2.4.1

Fixed the bug that Screen won't clear screen

V2.4.2

Added score board.

V2.4.3

Added command quit.

V2.4.4

Added new rule gomoku.

V2.5.0

Extracts game statistics as a whole structure.

V2.9.0

Extracts the whole game display to view package.

Added new game rule bomb

V3.0.0

Deprecated displayer and returns the scene building function back to the Board and GameController.

Added Unit Test for renderer, since such an analyzer is too big to debug when connected with the whole game.

Now the model layer interacts with view layer by passing an AbstractDisplayBlock, something like html, to the specified renderer to show the scene. The new feature allows dynamic generated scene rendered real-time and flexible.

V3.1.0

Added variable exceptions for illegal inputs. Now you can be warned in various ways!

Added new command demo.

I promise I will update this document later but not now : )