Skip to content

Latest commit

 

History

History
62 lines (47 loc) · 2.28 KB

README.md

File metadata and controls

62 lines (47 loc) · 2.28 KB

Disc Jockey

This is an example program that uses the Spirit of Korth's Software Development Wrapper for Active Worlds to interact with the Active Worlds. This program was inspired by the Disc Jockey written in C using the original Active Worlds SDK.

This project and/or its contributors are not affiliated with Active Worlds.

Usage

This program can both be used locally and through the use of the provided Docker image.

To use this program locally, you will need to have Python 3 installed. Then you can run the program with the following commands:

pip install -r requirements.txt
python ./disc_jockey

You can also run the program with the following command provided you have Docker installed:

docker build -t dj .
docker run -it dj

Configuration

This bot uses a json configuration file named "configuration.json" located in the same directory as the application.

Variable Description
BOT_NAME The name of the bot.
CITIZEN_NUMBER The owner of the bot.
PASSWORD The password of the bot.
WORLD_NAME The name of the world to connect to.
WORLD_X The x coordinate of the world to connect to.
WORLD_Y The y coordinate of the world to connect to.
WORLD_Z The z coordinate of the world to connect to.

X coordinates are west/east where west is positive and east is negative. Y coordinates represent height where up is positive and down is negative and ground is 0. Z coordinates are north/south where north is positive and south is negative.

Configuration example:

{
    "bot_name": "Plugin Bot",
    "world_name": "Test World",
    "world_coordinates": {
        "x": 0,
        "y": 0,
        "z": 0
    },
    "citizen_number": 123456,
    "password": "password"
}

License

This project is licensed under the MIT license.

Contribution

This project is open source. Feel free to contribute to the project by opening an issue, creating a pull request, or by contacting Johnny Irvin. I appreciate any feedback or contributions. This project is not affiliated with Active Worlds, Inc. The creator of this project is not affiliated with Active Worlds, Inc.