RogueSharp Documentation

RogueSharp provides efficient field-of-view calculations for a specified distance on a map. You can choose whether or not to light walls during the calculation.

• ComputeFov: Performs a new FOV calculation.
• AppendFov: Appends a new FOV calculation to any existing ones.

/// Constructs a new FieldOfView objec for the specified Map
public FieldOfView( IMap map )

/// Performs a field-of-view calculation with the specified parameters.
public ReadOnlyCollection<ICell> ComputeFov( int xOrigin, int yOrigin, int radius, bool lightWalls )

/// Performs a field-of-view calculation with the specified parameters
/// and appends it any existing field-of-view calculations.
public ReadOnlyCollection<ICell> AppendFov( int xOrigin, int yOrigin, int radius, bool lightWalls )

Most RogueSharp interactions revolve around the Map (an IMap implementation), which is a rectangular grid of Cell objects.

Each Cell contains state information relevant to roguelike mechanics:

• IsTransparent: Whether visibility extends through the cell.
• IsWalkable: Whether the player/entities can traverse the cell.
• IsExplored: Whether the player has ever had line-of-sight to the cell.
• IsInFov: Whether the cell is currently within the player's field-of-view.

RogueSharp provides a PathFinder class to calculate the shortest path between two cells on a map. You can configure whether the pathfinder considers diagonal movement by providing a diagonalCost during instantiation.

To find a path, use the ShortestPath method, which returns a Path object containing a list of Cell objects from the source to the destination.

/// Constructs a new PathFinder instance for the specified Map 
/// that will consider diagonal movement by using the specified diagonalCost
public PathFinder( IMap map, double diagonalCost )

/// Returns a shortest Path containing a list of Cells 
/// from a specified source Cell to a destination Cell
public Path ShortestPath( ICell source, ICell destination )

You can select groups of cells (rows, columns, circles, squares, or diamonds) using specific methods. For circular selections, RogueSharp uses Bresenham's midpoint circle algorithm.

• GetCellsInCircle: Returns all cells within a circle up to a specified radius.
• GetBorderCellsInCircle: Returns only the outermost border cells of a circle up to a specified radius.

/// Get an IEnumerable of Cells in a circle around the center Cell up 
/// to the specified radius using Bresenham's midpoint circle algorithm
public IEnumerable<ICell> GetCellsInCircle( int xCenter, int yCenter, int radius )
  
/// Get an IEnumerable of outermost border Cells in a circle around the center 
/// Cell up to the specified radius using Bresenham's midpoint circle algorithm
public IEnumerable<ICell> GetBorderCellsInCircle( int xCenter, int yCenter, int radius )

The quickest way to add RogueSharp to your C# project is by using the official NuGet package.

dotnet add package RogueSharp

Instead of a blank map, you can use the static Map.Create method combined with an IMapCreationStrategy. RogueSharp provides built-in strategies like RandomRoomsMapCreationStrategy. You can also implement your own custom strategy to define how maps are generated.

IMapCreationStrategy<Map> mapCreationStrategy = new RandomRoomsMapCreationStrategy<Map>( 17, 10, 30, 5, 3 )
IMap somewhatInterestingMap = Map.Create( mapCreationStrategy );
Console.WriteLine( somewhatInterestingMap.ToString() );

You can instantiate a new Map by providing a width and height. By default, all cell properties (transparency, walkability, etc.) are set to false.

IMap boringMapOfSolidStone = new Map( 5, 3 );
Console.WriteLine( boringMapOfSolidStone.ToString() );

The Map.ToString() method provides a text-based visual representation of the map. You can optionally pass a bool to ToString() to include field-of-view information (defaults to false).

Symbols used:

• %: Cell is not in field-of-view
• .: Cell is transparent, walkable, and in field-of-view
• s: Cell is walkable and in field-of-view (but not transparent)
• o: Cell is transparent and in field-of-view (but not walkable)
• #: Cell is in field-of-view (but not transparent or walkable)