aeternum-research-tool
v0.0.7
Published
A research tool that uses AI to search the web for information about the New World Aeternum expansion
Maintainers
Readme
Aeternum Research Tool
A modern web application for researching New World: Aeternum game content using Google's Gemini AI. Get detailed information about expansions, builds, crafting, and more through natural language queries.
Features
- 🤖 AI-Powered Research: Uses Google's Gemini AI for comprehensive game research
- 🔍 Natural Language Queries: Ask questions in plain English about New World content
- 📚 Source Citations: View sources and references for research results
- 📜 Search History: Keep track of previous research queries
- 🎨 Modern UI: Beautiful, responsive design with dark theme
- ⚡ Fast & Lightweight: Built with React and Vite for optimal performance
Prerequisites
- Node.js (v16 or higher)
- Google Gemini API key
Quick Start
No install with npx
npx aeternum-research-toolInstallation
Option 1: Install globally (Recommended)
npm install -g aeternum-research-tool
aeternum-research-toolThis will automatically download, build, and run the Aeternum Research Tool with a local server.
Option 2: Install from source
Clone the repository:
git clone https://github.com/involvex/new-world-expansion-research.git cd new-world-expansion-researchInstall dependencies:
npm installSet up your API key:
- Create a
.envfile in the root directory - Add your Gemini API key:
VITE_API_KEY=your_gemini_api_key_here - Alternatively, you can enter the API key directly in the app when prompted
- Create a
Usage
Using npx (Simplest)
npx aeternum-research-toolThe tool will automatically:
- Build the application (if needed)
- Start a local server on
http://localhost:3000 - Open your default browser
- Display the Aeternum Research Tool interface
Using from source
Start the development server:
npm run devOpen your browser and navigate to
http://localhost:5173Enter your research query in the search bar (e.g., "What's the new level cap in Nighthaven?")
View the AI-generated research results with sources
Features
- AI-Powered Research: Ask questions about New World Aeternum in natural language
- Download Results: Save research findings as markdown files
- Source Citations: View and access original sources
- Search History: Keep track of previous research queries
Available Scripts
npm run dev- Start development servernpm run build- Build for productionnpm run preview- Preview production buildnpm run lint- Run ESLint
Tech Stack
- Frontend: React 19, TypeScript, Tailwind CSS
- AI: Google Gemini AI
- Build Tool: Vite
- Linting: ESLint with React and TypeScript support
Project Structure
src/
├── components/ # React components
│ ├── Header.tsx # App header
│ ├── SearchBar.tsx # Search input component
│ ├── ResultsDisplay.tsx # Research results display
│ ├── HistoryLog.tsx # Search history
│ └── icons.tsx # Icon components
├── services/
│ └── geminiService.ts # Gemini AI integration
├── types.ts # TypeScript type definitions
└── App.tsx # Main app componentContributing
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Support
Buymeacoffee
https://www.buymeacoffee.com/involvex
