RPG Fantasy Character Name Generator

Welcome to the RPG Fantasy Character Name Generator! This project uses OpenAI to generate unique and interesting names for your characters in your fantasy role-playing games.

Prerequisites

Before you begin, you will need to have the following tools installed on your computer:

• Python 3
• Flask
• OpenAI

Installation

To install the project, follow these steps:

1. Clone the repository to your local machine:

   $ git clone https://github.com/McCReuben/CharacterNameGenerator.git

2. Navigate to the directory where the project was cloned and create a virtual environment:

cd CharacterNameGenerator
python3 -m venv venv

3. Make a copy of the example environment variables file

    $ cp .env.example .env

4. Activate the virtual environment:

   $ source venv/bin/activate

   If using Windows Powershell, run:

   $ . .venv/Scripts/activate

5. Install the dependencies (you may need to use pip3 instead):

   $ pip install -r requirements.txt

Usage

To use the project, follow these steps:

1. Run the Flask development server:

   $ export FLASK_APP=app.py
   $ flask run

2. Open your web browser and navigate to http://127.0.0.1:5000/ to access the application.
3. Use the form on the page to generate a random fantasy character name. You can specify the length of the name and whether it should be male or female.

Contributing

To contribute to the project, follow these steps:

1. Fork the repository.
2. Create a new branch for your changes.
3. Make the changes and commit them to your branch.
4. Push the changes to your fork.
5. Open a pull request and describe the changes you have made.