Code Monkey home page Code Monkey logo

boris's Introduction

Boris MUD

A MUD code base in the style of the last millennium, written in the new millennium.

Build Status

Table of Contents

Introduction

Cyberspace. A consensual hallucination experienced daily by billions of legitimate operators, in every nation, by children being taught mathematical concepts... A graphic representation of data abstracted from the banks of every computer in the human system. Unthinkable complexity. Lines of light ranged in the nonspace of the mind, clusters and constellations of data. Like city lights, receding. -- [William Gibson][1]

Boris MUD is a text-based virtual reality that allows multiple people to engage in roleplaying, adventuring, and story-telling.

Features

  • file-based database. Like NoSQL, but inferior in every way.

Building

Build requirements

  • CMake 3.12 (or later)
  • GNU Make 4.2.1 (or later)

Ubuntu / Debian Setup

sudo apt-get update
sudo apt-get install build-essential cmake libssl-dev zlib1g-dev

Alpine Linux

sudo apk update
sudo apk add build-base linux-headers make cmake git bash \
    zlib-dev openssl-libs-static openssl-dev openssl \

Check-out and Build from source

git clone --recurse-submodules http://github.com/OrangeTide/boris
cd boris
make -j

Build output is an executable (boris).

Optionally to use clang instead of default CC, as above except provide USE_CLANG=1 to make.

make -j USE_CLANG=1

For fast parallel builds, set USE_NINJA=1 to use ninja instead of make.

make USE_NINJA=1

To install the client (to bin/www/ by default)

make install

When running the server the client will be hosted at http://localhost:<webserver.port>

Usage

Configure

Edit configuration file (boris.cfg) with your preferred MUD port (server.port) and web port (webserver.port). And run the server:

Starting for the first time

$ ./bin/boris

Login and create your account.

TODO: provide instructions on how to shut down server cleanly

TODO: provide instructions on how to manually set administrator privileges on an account

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

License

Copyright (c) 2008-2019, Jon Mayo
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the Boris MUD project.

Links & Citations

[1]: Gibson, William (1984). Neuromancer. p. 69

boris's People

Contributors

kibels avatar orangetide avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

boris's Issues

login attempts fail the first time when using TinyFugue5

Pressing 'L' Enter then typing in user name reports "Invalid Login" without seeming to wait for my password.

Works on subsequent attempts. And doesn't block using TF, but sure is annoying.

Works fine every time with the generic telnet client on Linux.

Guessing some Telnet codes are being negotiated with TF and confusing the new-line handling?

Create a help system

Enhance the "help" command to access a help system.

Requirements for bug closure:

  • short write-up of how the help system works, in a README.md or ARCH.md
  • one or more help file(s) in the database
  • a high-level API for reading and listing help files in the database. (help.c)
  • enhance command_do_help() to access the help files

New Object Database for Rooms

Use LISP-like syntax to serialize objects and store in LMDB.
Modify room code to manipulate the object data structure.

add OLC commands and menus

Create a command-line builder and menu-based builder.

Usage:
"olc" - brings up a menu, choose Zones, Room, Items, Quests, NPCs, etc. (To be determined)

"olc room" - goes straight to the Room menu.

menu.c can be used for the menu code and command.c can be used for the command-line code.

Add "dig" command for builders

Add builder only commands for creating new rooms and opening links between rooms.

usage:

dig <direction>

result:

  • initialize a room using template for current zone (determined by current room)
  • creates connected exits in current room and the new room. (north=south, east=west, etc.)

Builder is expected to further edit the exits and rooms using other commands.

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.