Skip to content

Latest commit

 

History

History
128 lines (99 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

128 lines (99 loc) · 3.33 KB

🤝 Contributing to Xonotic

Thank you for your interest in contributing to Xonotic! We welcome contributions from the gaming community.

🎮 Ways to Contribute

🐛 Bug Reports

  • Use our Bug Report Template
  • Include system information and reproduction steps
  • Check existing issues first

💡 Feature Requests

🎨 Content Creation

  • Maps: Create new arenas and environments
  • Textures: High-resolution game assets
  • Models: 3D weapons and pickups
  • Audio: Sound effects and music

💻 Code Contributions

  • Engine Improvements: Performance and features
  • Gameplay Balance: Weapon tuning and mechanics
  • UI/UX: Menu and interface improvements
  • Networking: Multiplayer optimizations

🛠️ Development Setup

Prerequisites

  • Git
  • C/C++ compiler (GCC/Clang)
  • DarkPlaces engine source
  • QuakeC knowledge (for gameplay)

Building from Source

git clone https://github.com/Xonotic-Devs/xonotic
cd xonotic
make

Testing

  • Test in singleplayer with bots
  • Join multiplayer servers for testing
  • Verify cross-platform compatibility

📋 Pull Request Process

  1. Fork the repository
  2. Create feature branch (feature/awesome-weapon)
  3. Commit with clear messages
  4. Test thoroughly
  5. Submit pull request with description

Commit Messages

feat: add new rocket launcher weapon
fix: resolve multiplayer sync issue
docs: update weapon balance guide
style: improve menu layout

🎯 Coding Standards

QuakeC Guidelines

  • Use consistent indentation (4 spaces)
  • Comment complex gameplay logic
  • Follow existing naming conventions
  • Test weapon balance thoroughly

C/C++ Guidelines

  • Follow engine coding style
  • Add comments for engine modifications
  • Ensure memory safety
  • Profile performance changes

🌍 Community Guidelines

🤝 Be Respectful

  • Welcome newcomers to gaming
  • Provide constructive feedback
  • Respect different skill levels
  • Keep discussions gaming-focused

🎮 Gaming Focus

  • Consider competitive balance
  • Think about casual players
  • Maintain Quake-style gameplay
  • Preserve fast-paced action

🚀 Getting Started

Good First Issues

Look for issues labeled:

  • good first issue - Perfect for newcomers
  • documentation - Improve game docs
  • map creation - Design new arenas
  • beginner friendly - Low complexity

Community Channels

📖 Resources

Game Development

Asset Creation

❓ Questions?

  • 💬 Join our Discord
  • 📧 Email maintainers
  • 🐛 Open an issue for bugs
  • 💡 Start a discussion for ideas

Ready to frag some code? 🎮 We're excited to see your contributions!