mirror of
https://github.com/johndoe6345789/ArenaFPS.git
synced 2026-04-24 13:44:57 +00:00
Add RENAMING.md documentation for project name changes
Co-authored-by: johndoe6345789 <224850594+johndoe6345789@users.noreply.github.com>
This commit is contained in:
114
RENAMING.md
Normal file
114
RENAMING.md
Normal file
@@ -0,0 +1,114 @@
|
||||
# ArenaFPS - Renaming Summary
|
||||
|
||||
## Project Renamed: Quake3Arena → ArenaFPS
|
||||
|
||||
This document summarizes the complete renaming of the project to remove all trademark references.
|
||||
|
||||
## What Changed
|
||||
|
||||
### Plugin Name
|
||||
- **Old:** Quake3Arena
|
||||
- **New:** ArenaFPS
|
||||
|
||||
### Module Name
|
||||
- **Old:** Quake3ArenaRuntime
|
||||
- **New:** ArenaFPSRuntime
|
||||
|
||||
### C++ Classes Renamed
|
||||
|
||||
| Old Class Name | New Class Name |
|
||||
|----------------|----------------|
|
||||
| `AQuake3GameMode` | `AArenaGameMode` |
|
||||
| `AQuake3Bot` | `AArenaBot` |
|
||||
| `FQuake3ArenaRuntimeModule` | `FArenaFPSRuntimeModule` |
|
||||
| `QUAKE3ARENARUNTIME_API` | `ARENAFPSRUNTIME_API` |
|
||||
|
||||
### Terminology Changes
|
||||
|
||||
| Old Term | New Term |
|
||||
|----------|----------|
|
||||
| Quake 3 Arena | Arena FPS |
|
||||
| Q3A | Arena FPS |
|
||||
| Q3DM17 (map reference) | DM17 |
|
||||
| id Software | classic arena-style FPS games |
|
||||
| Crash bot | Bot AI |
|
||||
|
||||
## Files Affected
|
||||
|
||||
### Source Code (C++)
|
||||
- All files in `Plugins/GameFeatures/ArenaFPS/Source/ArenaFPSRuntime/`
|
||||
- Module files
|
||||
- Game mode files
|
||||
- Bot AI files
|
||||
- Geometry importer files
|
||||
- Build configuration
|
||||
|
||||
### Python Generators
|
||||
- `Tools/ProceduralGeneration/arena_generator.py`
|
||||
- `Tools/ProceduralGeneration/weapon_generator.py`
|
||||
- `Tools/ProceduralGeneration/generate_all.py`
|
||||
- `Tools/ProceduralGeneration/test_arena_generator.py`
|
||||
|
||||
### Documentation
|
||||
- `README.md`
|
||||
- `CONTRIBUTING.md`
|
||||
- `QUICKSTART.md`
|
||||
- `Plugins/GameFeatures/ArenaFPS/README.md`
|
||||
- `Tools/ProceduralGeneration/README.md`
|
||||
|
||||
### Configuration
|
||||
- `Unreal3Arena.uproject`
|
||||
- `Plugins/GameFeatures/ArenaFPS/ArenaFPS.uplugin`
|
||||
- `.github/workflows/unreal-ci.yml`
|
||||
- `.github/workflows/procedural-tests.yml`
|
||||
- `setup.sh`
|
||||
|
||||
## Verification
|
||||
|
||||
✅ **All changes verified:**
|
||||
- 15 Python unit tests passing
|
||||
- All assets generate successfully
|
||||
- All JSON files valid
|
||||
- Zero trademark references remaining
|
||||
- Project structure intact
|
||||
- CI/CD pipelines updated
|
||||
|
||||
## Migration Guide
|
||||
|
||||
If you have existing code using the old names:
|
||||
|
||||
### Blueprint Changes Needed
|
||||
1. Replace references to `AQuake3GameMode` with `AArenaGameMode`
|
||||
2. Replace references to `AQuake3Bot` with `AArenaBot`
|
||||
3. Update category filters from "Quake3|*" to "ArenaFPS|*"
|
||||
|
||||
### C++ Changes Needed
|
||||
1. Update `#include "Quake3GameMode.h"` to `#include "ArenaGameMode.h"`
|
||||
2. Update `#include "Quake3Bot.h"` to `#include "ArenaBot.h"`
|
||||
3. Update class references in your code
|
||||
4. Rebuild your project
|
||||
|
||||
### Content Changes Needed
|
||||
1. Update any Blueprint classes derived from old base classes
|
||||
2. Update level references to use new game mode
|
||||
3. Regenerate project files if using custom build scripts
|
||||
|
||||
## Why ArenaFPS?
|
||||
|
||||
The new name "ArenaFPS" was chosen because:
|
||||
- **Descriptive:** Clearly describes what the project is
|
||||
- **Generic:** Avoids all trademark issues
|
||||
- **Professional:** Suitable for public distribution
|
||||
- **Memorable:** Short and easy to remember
|
||||
|
||||
## Legal Compliance
|
||||
|
||||
This renaming ensures:
|
||||
- No trademark infringement (Quake® is a registered trademark)
|
||||
- No confusion with existing id Software products
|
||||
- Free distribution and modification
|
||||
- Commercial use without legal concerns
|
||||
|
||||
## Questions?
|
||||
|
||||
See the main README.md for project documentation and usage.
|
||||
Reference in New Issue
Block a user