Giter VIP home page Giter VIP logo

rpg-tools's Introduction

RPG Tools

Simple RPG helper tools for generating content for tabletop role-playing games (or any other game that uses maps).

Currently rpgmap is the only available tool but more are planned:

  • Non-player character (NPC) generator
  • Town generator
  • World-map generator
  • ... (ideas welcome)

RPG Map

rpgmap is a grid-based map generator. This is the primary tool available right now.

Example maps look like this:

rpgmap -x 50 -y 50 --num-rooms 50 --room-size 7

Example halls map

rpgmap -s cave -x 50 -y 50

Example caves map

The two primary room types are halls (default) and cave. Halls represt a classical rogue-like dungeon; rooms are rectangular and placed randomly on a grid and then connected by single-width hallways. No effort is made to ensure that the rooms overlap, which creates interesting non-rectangular rooms when they overlap.

Caves are organic-looking blobs that are created by filling the grid with random cells and then annealing using a cellular automata mechanism. This creates blobs that vaguely resemble water-carved caves. The cellular automata strategy can produce blobs that are not connected, when this occurs, they're removed (if too small) or connected via a hallway.

Maps have an orange square that appears near the middle, which is intended to be the entrance.

Note on aesthetics: I am not a capable artist and the maps are kind of ugly. To be improved in the future.

Install

Make sure that you have the Rust compiler and cargo installed.

cargo build --release
./target/release/rpgmap --help

Usage

For argument descriptions:

$ rpgmap --help
A simple map generator for role playing games

Usage: rpgmap [OPTIONS]

Options:
  -x, --width <INT>        The horizontal width of the map [default: 50]
  -y, --height <INT>       The vertical height of the map [default: 50]
  -s, --style <map-style>  The style of map to generate [default: halls] [possible values: halls, cave]
  -S, --scale <INT>        The number of pixels for each square [default: 25]
  -o, --output <NAME>      The name of the output file [default: rpgmap.png]
      --num-rooms <INT>    The number of rooms to generate [default: 30]
      --room-size <INT>    The size of generated rooms [default: 10]
  -h, --help               Print help
  -V, --version            Print version

rpg-tools's People

Contributors

seilis avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

xzar90 ale789987

rpg-tools's Issues

More dungeon creation options

There are a number of internal parameters that are not-yet exposed to the user. These include:

  • Number of rooms
  • Room "distance" parameter for connections
  • Cave random initialization and annealing parameters

Better visuals: blender support

The current visuals work but are fairly bland. It would be fun to have a 3D view, which could be done by integrating a tool like Blender somehow.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.