Package Exports
- rpg-event-generator
- rpg-event-generator/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (rpg-event-generator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
RPG Event Generator
A powerful procedural event generation system for RPG games, capable of creating virtually infinite contextual events based on player state and game world.
Note: This package was originally created for a personal RPG project and shared publicly because it might be useful for other game developers. The repository is private, so bug reports and maintenance issues cannot be submitted directly. Check npm regularly for updates, new features, or breaking changes.
Installation
npm install rpg-event-generatorQuick Start
import { RPGEventGenerator, generateRPGEvent } from 'rpg-event-generator';
// Simple event generation
const event = generateRPGEvent({
age: 25,
gold: 500,
influence: 15,
career: 'merchant'
});
console.log(event.title); // "Golden Opportunity"
console.log(event.description); // Procedurally generated narrative
console.log(event.choices); // Array of meaningful choicesDemo
Run the included demo.js file to see the RPG Event Generator in action:
node demo.jsThis will demonstrate various features including event generation, chains, time progression, and customization options.
Maintenance & Updates
Since this is a personal project with a private repository:
- Check npm regularly for new versions and features
- Monitor the changelog in package updates for breaking changes
- Run the demo to explore new functionality
- No direct bug reports or feature requests can be accepted
Features
- Infinite Event Generation: Custom Markov chains create unique, contextual events
- Player-Aware: Events adapt to stats, career, relationships, reputation, and social standing
- 14+ Event Types: Court scandals, noble duels, ancient curses, bandit kings, and more
- Immersive Storytelling: Rich narratives with atmospheric descriptions and meaningful consequences
- Dynamic Difficulty Scaling: Events automatically scale based on player power level
- Thematic Training Sets: Fantasy, sci-fi, and historical themes with cultural variants
- Event Chains: Multi-part story sequences with escalating consequences
- Time-Based Events: Seasonal changes and evolving long-term storylines
- Modular Event System: Create and manage custom templates, training data, and chains
- Game Integration: Proper save/load state management for real games
- Comprehensive Testing: 45+ automated tests ensuring reliability
Enhanced Features (v1.2.0)
- ๐ Multi-Language Support: Generate events in different languages with cultural adaptation
- ๐ Event Dependencies: Complex prerequisite systems for event triggering
- ๐ค๏ธ Environmental Modifiers: Weather, season, and location-based event modifications
- ๐ฅ NPC Relationships: Dynamic character relationship networks and social consequences
๐ Usage Guide
Basic Event Generation
const generator = new RPGEventGenerator();
const event = generator.generateEvent();
console.log(event);
// {
// id: "event_1704567890123_xyz789",
// title: "Perilous Bandit King's Challenge",
// description: "Generated narrative based on Markov chains...",
// choices: [
// { text: "Fight back", effect: { health: -20, reputation: 25 } },
// { text: "Pay tribute", effect: { gold: -200, safe_passage: true } }
// ],
// type: "BANDIT_KING",
// difficulty: "normal"
// }Context-Aware Events
const playerContext = {
age: 35,
gold: 2500,
influence: 40,
reputation: 25,
career: 'noble',
skills: { diplomacy: 70, combat: 45, intrigue: 30 },
relationships: [
{ name: 'Lord Harrington', type: 'ally', relationship: 60 }
],
location: 'capital',
season: 'winter'
};
const event = generator.generateEvent(playerContext);
// Generates events appropriate to noble career, high influence, winter seasonCustom Training Data
Enhance text generation with your own story fragments:
const customTrainingData = [
'In the shadowed alleys of the ancient city',
'The dragon\'s roar echoes through the misty mountains',
'Elven merchants display their enchanted crystal wares',
'A dwarven smith forges weapons of legendary power',
'The tavern overflows with adventurers and mysterious strangers',
'Ancient runes glow with ethereal magical energy',
'The enchanted forest whispers secrets to those who listen carefully'
];
const generator = new RPGEventGenerator({
trainingData: customTrainingData
});
// Events will now incorporate your custom story elements
const event = generator.generateEvent();
// May generate: "In the shadowed alleys of the ancient city, a mysterious stranger approaches..."Thematic Training Sets
// Fantasy (default) - knights, magic, dragons
const fantasyGen = new RPGEventGenerator({ theme: 'fantasy' });
// Fantasy with Norse culture - vikings, runes, fjords
const norseGen = new RPGEventGenerator({
theme: 'fantasy',
culture: 'norse'
});
const norseEvent = norseGen.generateEvent();
// Generates: "The longships sail into the fjord under the northern lights..."
// Sci-fi - corporations, AI, space exploration
const sciFiGen = new RPGEventGenerator({ theme: 'sci-fi' });
// Cyberpunk sci-fi - neon cities, megacorps, hackers
const cyberpunkGen = new RPGEventGenerator({
theme: 'sci-fi',
culture: 'cyberpunk'
});
const cyberEvent = cyberpunkGen.generateEvent();
// Generates: "Neon lights reflect off rain-slicked streets in the megacity sprawl..."
// Historical - medieval politics, exploration, warfare
const historicalGen = new RPGEventGenerator({ theme: 'historical' });
// Victorian historical - industrial revolution, social reform
const victorianGen = new RPGEventGenerator({
theme: 'historical',
culture: 'victorian'
});
const victorianEvent = victorianGen.generateEvent();
// Generates: "Steam engines power the industrial revolution across soot-stained cities..."Event Chains
// Start a multi-part storyline
const generator = new RPGEventGenerator();
const firstEvent = generator.startChain('BANDIT_RISING');
console.log(firstEvent.title); // "Treacherous Bandit Ambush"
console.log(firstEvent.chainId); // "chain_1704567890123_xyz789"
// Advance chain based on player choice
const nextEvent = generator.advanceChain(firstEvent.chainId, 'hero');
console.log(nextEvent.title); // "Perilous Bandit King's Challenge"
// Check active chains
const activeChains = generator.getActiveChains();
console.log(`Active chains: ${activeChains.length}`);
// Available built-in chains:
// - BANDIT_RISING: Highway robbery escalating to kingdom threat
// - COURT_SCANDAL_CHAIN: Royal intrigue with multiple betrayals
// - CURSE_OF_THE_ARTIFACT: Ancient curse with escalating effects
// - MERCHANT_EMPIRE: Trade empire building with setbacksTime-Based Events
// Advance game time and handle due events
const dueEvents = generator.advanceGameDay();
dueEvents.forEach(event => {
if (event.type === 'time_based_chain') {
const chainData = generator.timeSystem.timeBasedEvents.get(event.chainId);
const gameEvent = generator.generateChainEvent(chainData);
// Add to your game's event system
}
});
// Start evolving storylines
generator.startTimeBasedChain('POLITICAL_UPRISING');
// - Day 1: Whispers of dissent appear
// - Day 7: Public protests erupt
// - Day 14: Open rebellion begins
// - Day 21: Revolutionary climax
// Check current game time
const currentTime = generator.getCurrentTime();
console.log(`Day ${currentTime.day}, Season: ${currentTime.season}`);Multi-Language Support ๐
Generate events in different languages with cultural adaptation:
const generator = new RPGEventGenerator({
language: 'es', // Spanish events
theme: 'fantasy'
});
// Load additional language packs
generator.loadLanguagePack('fr', frenchTranslations);
generator.setLanguage('fr');
// Events now generate in French
const event = generator.generateEvent();
console.log(event.title); // "Embuscade de Brigands"Environmental Modifiers ๐ค๏ธ
Weather, season, and location affect event generation:
const generator = new RPGEventGenerator({ enableModifiers: true });
// Set environmental context
generator.setEnvironmentalContext({
weather: 'storm',
season: 'winter',
timeOfDay: 'night'
});
// Events adapt to harsh winter storm conditions
const event = generator.generateEnhancedEvent({
environment: { weather: 'storm', season: 'winter' }
});Event Dependencies ๐
Complex prerequisite systems control when events can occur:
// Register event dependencies
generator.registerEventDependency('ROYAL_WEDDING', {
type: 'event_completed',
eventId: 'COURT_INTRODUCTION'
});
generator.registerEventDependency('ADVANCED_QUEST', {
operator: 'AND',
conditions: [
{ type: 'stat_requirement', stat: 'level', min: 5 },
{ type: 'event_completed', eventId: 'BASIC_QUEST' }
]
});
// Only generate events whose dependencies are met
const gameState = { completedEvents: new Set(['COURT_INTRODUCTION']) };
const event = generator.generateEnhancedEvent({ gameState });NPC Relationship Networks ๐ฅ
Dynamic character relationships that evolve based on player actions:
const generator = new RPGEventGenerator({ enableRelationships: true });
// Add NPCs to the relationship network
generator.addNPC({
id: 'king_arthur',
name: 'King Arthur',
type: 'noble'
});
// Update relationships based on player actions
generator.applyRelationshipRule('king_arthur', 'player', 'save_life');
// Relationship with king improves significantly
generator.updateRelationship('merchant_john', 'player', -10, 'stole goods');
// Relationship with merchant deteriorates
// Generate events that consider relationship context
const event = generator.generateEnhancedEvent({
player: { id: 'player' }
});Modular Event System
// Register custom event templates
const customTemplate = {
title: 'Mystic Vision',
narrative: 'You experience a vivid prophetic dream showing future events.',
choices: [
{
text: 'Seek out the prophecy',
effect: { wisdom: 15, risk: 20 },
consequence: 'visionary'
},
{
text: 'Dismiss it as a dream',
effect: { stress: -10 },
consequence: 'skeptical'
}
]
};
generator.registerEventTemplate('MYSTIC_VISION', customTemplate);
// Add custom training data for better text generation
generator.addCustomTrainingData([
'The ancient prophecy foretells of great change',
'Mystic visions reveal hidden truths to the worthy',
'Dreams of the future guide the destinies of heroes'
], 'mystical');
// Create custom event chains
const visionChain = {
name: 'Prophetic Journey',
description: 'A chain of events triggered by mystic visions',
stages: [
{ day: 1, template: 'MYSTIC_VISION' },
{ day: 5, template: 'ANCIENT_RUINS' },
{ day: 10, template: 'FINAL_PROPHECY' }
]
};
generator.registerEventChain('PROPHECY_CHAIN', visionChain);
// Export/import custom content for sharing
const customContent = generator.exportCustomContent();
console.log('Exported:', Object.keys(customContent.templates).length, 'templates');
const newGenerator = new RPGEventGenerator();
const importResult = newGenerator.importCustomContent(customContent);
console.log('Imported:', importResult.templates.success, 'templates');Dynamic Difficulty Scaling
Events automatically scale based on player power level:
// Weak character (easy difficulty)
const weakling = {
gold: 50,
influence: 10,
skills: { combat: 20 }
};
const easyEvent = generator.generateEvent(weakling);
console.log(`Difficulty: ${easyEvent.difficulty}`); // "easy"
// Effects scaled for beginners: higher rewards, lower penalties
// Powerful character (hard difficulty)
const hero = {
gold: 50000,
influence: 500,
skills: { combat: 100, diplomacy: 80 },
relationships: [{ name: 'King', type: 'ally', relationship: 80 }]
};
const hardEvent = generator.generateEvent(hero);
console.log(`Difficulty: ${hardEvent.difficulty}`); // "hard"
// Effects scaled for challenge: lower rewards, higher penalties
// Legendary character (legendary difficulty)
const godlike = {
gold: 200000,
influence: 1000,
skills: { combat: 200, diplomacy: 150 },
age: 120,
reputation: 95
};
const epicEvent = generator.generateEvent(godlike);
console.log(`Difficulty: ${epicEvent.difficulty}`); // "legendary"
// Effects scaled for epic gameplay: minimal rewards, maximum penaltiesDifficulty Tiers:
- Easy (Power 0-50): Generous rewards, forgiving penalties
- Normal (Power 25-150): Standard scaling, balanced challenges
- Hard (Power 100-300): Reduced rewards, harsher penalties
- Legendary (Power 250+): Minimal rewards, extreme challenges
๐ง API Reference
Constructor Options
const generator = new RPGEventGenerator({
// Core options
stateSize: 2, // Markov chain state size (default: 2)
trainingData: [...], // Custom training data array
theme: 'fantasy', // 'fantasy', 'sci-fi', 'historical'
culture: 'norse', // Cultural variant within theme
// Enhanced features (all enabled by default)
enableDependencies: true, // Complex event prerequisites
enableModifiers: true, // Weather/season/location modifiers
enableRelationships: true, // NPC relationship networks
language: 'en' // Default language for events
});Core Methods
generateEvent(playerContext)- Generate single eventgenerateEvents(playerContext, count)- Generate multiple eventsgenerateTimeAwareEvent(playerContext)- Generate season-aware event
Event Chain Methods
startChain(chainId)- Start choice-based event chainadvanceChain(chainId, choice)- Advance chain based on choicegetActiveChains()- Get all active chains
Time-Based Methods
advanceGameDay()- Advance time and return due eventsstartTimeBasedChain(chainId)- Start time-evolving chaingetCurrentTime()- Get current game time/seasongetActiveTimeChains()- Get active time-based chains
Game State Methods
getGameState()- Export complete game stateloadGameState(state)- Import saved game state
Modular Methods
registerEventTemplate(id, template)- Add custom event templateaddCustomTrainingData(data, category)- Add custom training dataregisterEventChain(id, chainConfig)- Add custom event chainexportCustomContent()- Export custom templates/chains/dataimportCustomContent(content)- Import custom content
Player Context Object
{
age: number, // Player age
gold: number, // Player wealth
influence: number, // Political/social influence
reputation: number, // Social reputation
career: string, // Player's career/job ('noble', 'merchant', 'warrior', etc.)
skills: { // Skill levels object
combat: number, // 0-100 scale
diplomacy: number,
intrigue: number,
magic: number,
survival: number
},
relationships: [{ // Array of NPC relationships
name: string, // NPC name
type: string, // 'friend', 'lover', 'ally', 'enemy', 'rival'
relationship: number // Relationship strength (0-100)
}],
location: string, // Current location ('capital', 'village', 'forest', etc.)
season: string // Current season ('spring', 'summer', 'autumn', 'winter')
}Complete Event Object Structure
{
id: "event_1704567890123_xyz789", // Unique event identifier
title: "Perilous Bandit King's Challenge", // Dynamic, context-aware title
description: "The infamous bandit king blocks your path, offering you a choice...", // Rich procedural description
narrative: "The infamous bandit king blocks your path, offering you a choice: join his band or face certain death.",
choices: [
{
text: "Join the bandits",
effect: { gold: 375, reputation: -23, combat_skill: 12 },
consequence: "bandit"
},
{
text: "Challenge him to single combat",
effect: { reputation: 32, health: -18 },
requirements: { combat_skill: 60 },
consequence: "hero"
},
{
text: "Bribe your way past",
effect: { gold: -320, safe_passage: true },
consequence: "diplomat"
}
],
type: "BANDIT_KING",
consequence: null,
context: { /* Full context used for generation */ },
urgency: "normal",
theme: "adventure",
difficulty: "normal"
}๐ฎ Game Integration
Real-Time Strategy Integration
function onNewGameDay() {
const dueEvents = generator.advanceGameDay();
dueEvents.forEach(event => {
if (event.type === 'time_based_chain') {
const chainData = generator.timeSystem.timeBasedEvents.get(event.chainId);
const gameEvent = generator.generateChainEvent(chainData);
triggerInGameEvent(gameEvent);
} else if (event.type === 'seasonal_random') {
const seasonalEvent = generator.generateTimeAwareEvent(playerContext);
triggerInGameEvent(seasonalEvent);
}
});
}React Game Integration
import React, { useState, useEffect } from 'react';
import { RPGEventGenerator } from 'rpg-event-generator';
function GameEventSystem({ playerStats }) {
const [currentEvent, setCurrentEvent] = useState(null);
const [generator] = useState(() => new RPGEventGenerator());
useEffect(() => {
// Generate event when time advances
const event = generator.generateEvent(playerStats);
setCurrentEvent(event);
}, [playerStats, generator]);
const handleChoice = (choiceIndex) => {
const choice = currentEvent.choices[choiceIndex];
// Apply effects to player stats
applyEffects(choice.effect);
setCurrentEvent(null); // Clear event
};
if (!currentEvent) return <div>No active events</div>;
return (
<div className="event-dialog">
<h2>{currentEvent.title}</h2>
<p>{currentEvent.description}</p>
<div className="choices">
{currentEvent.choices.map((choice, index) => (
<button
key={index}
onClick={() => handleChoice(index)}
className="choice-button"
>
{choice.text}
</button>
))}
</div>
</div>
);
}Redux Integration
// Action Types
export const GENERATE_EVENT = 'GENERATE_EVENT';
export const RESOLVE_EVENT = 'RESOLVE_EVENT';
export const ADVANCE_GAME_DAY = 'ADVANCE_GAME_DAY';
// Action Creators
export const generateEvent = (playerContext) => ({
type: GENERATE_EVENT,
payload: { playerContext }
});
export const resolveEvent = (eventId, choiceIndex) => ({
type: RESOLVE_EVENT,
payload: { eventId, choiceIndex }
});
export const advanceGameDay = () => ({
type: ADVANCE_GAME_DAY
});
// Reducer
const initialState = {
generator: new RPGEventGenerator(),
currentEvent: null,
gameTime: { day: 1, season: 'spring' }
};
const eventReducer = (state = initialState, action) => {
switch (action.type) {
case GENERATE_EVENT:
const event = state.generator.generateEvent(action.payload.playerContext);
return { ...state, currentEvent: event };
case RESOLVE_EVENT:
// Apply choice effects to player state
const choice = state.currentEvent.choices[action.payload.choiceIndex];
const newPlayerState = applyChoiceEffects(choice.effect);
return {
...state,
currentEvent: null,
playerState: newPlayerState
};
case ADVANCE_GAME_DAY:
const dueEvents = state.generator.advanceGameDay();
return {
...state,
gameTime: state.generator.getCurrentTime(),
dueEvents: dueEvents
};
default:
return state;
}
};Save/Load System
// Save complete game state
function saveGame(playerState) {
const gameState = {
player: playerState,
events: generator.getGameState(),
timestamp: Date.now()
};
localStorage.setItem('rpgGameSave', JSON.stringify(gameState));
console.log('Game saved successfully');
}
// Load complete game state
function loadGame() {
try {
const savedGame = JSON.parse(localStorage.getItem('rpgGameSave'));
if (!savedGame) return false;
// Restore generator state
generator.loadGameState(savedGame.events);
// Restore player state
return savedGame.player;
} catch (error) {
console.error('Failed to load game:', error);
return false;
}
}๐งช Testing
npm testComprehensive test coverage (45+ tests):
- โ Core event generation and validation
- โ Context adaptation and player responsiveness
- โ Thematic systems and cultural variants
- โ Event chains and multi-stage progression
- โ Dynamic difficulty scaling
- โ Time systems and seasonal mechanics
- โ Modular features and custom content
- โ Edge cases and error handling
- โ Game state persistence and integration
๐ฏ Event Types
Court & Political
- Court Scandal: Royal intrigue with betrayal and scandal
- Noble Duel: Honour challenges and duels of reputation
- Market Crash: Economic disasters affecting trade
- Trade War: Merchant rivalries and economic warfare
Criminal Underworld
- Thieves' Guild: Criminal organisation recruitment
- Blackmail Opportunity: Leverage compromising information
- Bandit King Challenge: Highway robbery confrontations
Supernatural & Mysterious
- Ancient Curse: Cursed artefacts and afflictions
- Ghostly Visitation: Spirits seeking justice
- Lost Civilisation: Archaeological discoveries
Personal & Dramatic
- Forbidden Love: Romance across social boundaries
- Family Secret: Hidden lineage revelations
- Desertion Temptation: Military loyalty crises
- Mercenary Contract: Dangerous employment opportunities
๐ License
MIT License - see LICENSE file for details.
๐ Acknowledgments
- Chance.js for random number generation
- Custom Markov chain implementation for procedural text generation
Generate infinite adventures with RPG Event Generator! โ๏ธ๐โจ