backups/Fantasy-Map-Generator
1
0
Fork 0
mirror of https://github.com/Azgaar/Fantasy-Map-Generator.git synced 2025-12-18 02:01:22 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated Ollama text generation (markdown)

Azgaar 2025-06-14 15:19:28 +02:00
parent ea99f38d5c
commit 0d26d2f072
1 changed files with 49 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

84
Ollama-text-generation.md

@ -1,51 +1,65 @@
An integration with [Ollama](https://ollama.com/) allows users to leverage local large language models to generate text data for the Map Generator.
# Ollama integration with Fantasy Map Generator
An integration with [Ollama](https://ollama.com/) allows users to leverage local large language models to generate text data for the Fantasy Map Generator.
## Setup and Configuration
To use Ollama with Fantasy Map Generator, you need to ensure Ollama is correctly running and configured on your machine.
**1. Install Ollama:**
### 1. Install Ollama
* Download and install Ollama from [ollama.com](https://ollama.com/).
* Download the desired models (e.g., `ollama run llama3`).
- Download and install Ollama from [ollama.com](https://ollama.com/)
- Download the desired models (e.g., `ollama run llama3`)
**2. Configure Ollama for Network Access (Crucial Step):**
### 2. Configure Ollama for Network Access (Crucial Step)
By default, Ollama might only listen for connections from the same machine (`localhost` or `127.0.0.1`). For Fantasy Map Generator to access Ollama, especially from other devices on your local network, you must configure Ollama to listen on all network interfaces and allow cross-origin requests.
* Set `OLLAMA_HOST` Environment Variable:
* This variable tells Ollama which network interfaces to listen on.
* **Action:** Set `OLLAMA_HOST` to `0.0.0.0`.
* **How to set (Windows Permanent):**
1. Search for "Edit the system environment variables" in the Windows search bar.
2. Click "Environment Variables...".
3. In the "System variables" section (bottom pane), click "New..." (or "Edit..." if it exists).
4. Variable name: `OLLAMA_HOST`
5. Variable value: `0.0.0.0`
6. Click "OK" on all dialogs.
7. **Restart your PC** for the changes to take effect for all processes.
* **How to set (Linux/macOS - per session or persistent):**
1. **Per session:** In your terminal, before running `ollama serve`: `export OLLAMA_HOST="0.0.0.0"`
2. **Persistent:** Add `export OLLAMA_HOST="0.0.0.0"` to your shell profile file (e.g., `~/.bashrc`, `~/.zshrc`), then `source` the file or restart your terminal.
#### Set `OLLAMA_HOST` Environment Variable
* Set `OLLAMA_ORIGINS` Environment Variable (CORS Configuration):
* This variable is essential for browsers to allow JavaScript code from one origin (Fantasy Map Generator's port 8000) to communicate with Ollama on a different port (11434).
* **Action:** Set `OLLAMA_ORIGINS` to allow your Fantasy Map Generator's origin.
* **How to set (Windows Permanent):** Follow the same steps as for `OLLAMA_HOST`, but use:
* Variable name: `OLLAMA_ORIGINS`
* Variable value: `http://<YOUR_PC_IP_ADDRESS>:8000` (e.g., `http://192.168.178.46:8000`)
* **For development (easiest):** You can use `*` as the value (`OLLAMA_ORIGINS=*`) to allow all origins. This is less secure for production but simplifies testing.
* **Restart your PC** after setting the variable.
* **How to set (Linux/macOS - per session or persistent):**
1. **Per session:** `export OLLAMA_ORIGINS="http://<YOUR_PC_IP_ADDRESS>:8000"` or `export OLLAMA_ORIGINS="*"`
2. **Persistent:** Add the `export` line to your shell profile file.
This variable tells Ollama which network interfaces to listen on.
* **Firewall Configuration:**
* Ensure your PC's firewall (e.g., Windows Defender Firewall) is not blocking incoming connections to Ollama's default port, `11434`.
* **Action:** Create an inbound rule to allow TCP traffic on port `11434`.
**Action:** Set `OLLAMA_HOST` to `0.0.0.0`
**3. Configure Fantasy Map Generator**
**How to set (Windows Permanent):**
1. Search for "Edit the system environment variables" in the Windows search bar
2. Click "Environment Variables..."
3. In the "System variables" section (bottom pane), click "New..." (or "Edit..." if it exists)
4. Variable name: `OLLAMA_HOST`
5. Variable value: `0.0.0.0`
6. Click "OK" on all dialogs
7. **Restart your PC** for the changes to take effect for all processes
**How to set (Linux/macOS - per session or persistent):**
- **Per session:** In your terminal, before running `ollama serve`: `export OLLAMA_HOST="0.0.0.0"`
- **Persistent:** Add `export OLLAMA_HOST="0.0.0.0"` to your shell profile file (e.g., `~/.bashrc`, `~/.zshrc`), then `source` the file or restart your terminal
#### Set `OLLAMA_ORIGINS` Environment Variable (CORS Configuration)
This variable is essential for browsers to allow JavaScript code from one origin (Fantasy Map Generator's port 8000) to communicate with Ollama on a different port (11434).
**Action:** Set `OLLAMA_ORIGINS` to allow your Fantasy Map Generator's origin
**How to set (Windows Permanent):** Follow the same steps as for `OLLAMA_HOST`, but use:
- Variable name: `OLLAMA_ORIGINS`
- Variable value: `http://<YOUR_PC_IP_ADDRESS>:8000` (e.g., `http://192.168.178.46:8000`)
**For development (easiest):** You can use `*` as the value (`OLLAMA_ORIGINS=*`) to allow all origins. This is less secure for production but simplifies testing.
**Restart your PC** after setting the variable.
**How to set (Linux/macOS - per session or persistent):**
- **Per session:** `export OLLAMA_ORIGINS="http://<YOUR_PC_IP_ADDRESS>:8000"` or `export OLLAMA_ORIGINS="*"`
- **Persistent:** Add the `export` line to your shell profile file
#### Firewall Configuration
Ensure your PC's firewall (e.g., Windows Defender Firewall) is not blocking incoming connections to Ollama's default port, `11434`.
**Action:** Create an inbound rule to allow TCP traffic on port `11434`
### 3. Configure Fantasy Map Generator
Select `ollama` from the list of models and provide desired model name to the `key` field. You don't need a key, so use this field to define the model name.
The FMG points `http://localhost:11434/api/generate` for Ollama generation. In you need a different endpoint, change it in the `ai-generator.js` file.
The FMG points to `http://localhost:11434/api/generate` for Ollama generation. If you need a different endpoint, change it in the `ai-generator.js` file.