Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Catalog · How the catalog works
Anything · Lazarus or Delphi
Random projectRandom project

ekron-realms

Official Ekron Realms Client

View on GitHub

Member rating

No ratings yet.

Sign in to rate this project.

README

This is the fully updated and polished README.md content you provided.


Ekron Realms FPS

Overview

Ekron Realms FPS is an exhilarating open-source first-person shooter game, developed with the Free Pascal Compiler and Lazarus IDE. Whether you're diving into the immersive campaign or contributing to the codebase, Ekron Realms FPS offers a thrilling and collaborative experience.

The game is built for both players and developers, encouraging community-driven innovation and creativity.

Key Features

  • Open Source: Fully licensed under the GPL v3, promoting openness, modifications, and community contributions.
  • Cross-Platform Compatibility: Runs seamlessly on:
    • Windows, macOS, Linux: Fully supported on major desktop operating systems.
    • Raspberry Pi: Optimized for ARM devices like Raspberry Pi 3+.
    • Apple Silicon: Native support for M1, M2, and newer Apple chips.
    • Android & iOS: Playable on both Android and Apple mobile devices.
  • Powerful Development Tools: Built with Free Pascal and Lazarus IDE 3.0 for accessible and robust development.
  • Community-Driven Development: Contributions from developers worldwide shape the game's evolution.
  • Customizable and Expandable: Designed with modding and expandability in mind.

Getting Started

Prerequisites

Before diving in, make sure you have the following tools installed:

  • Free Pascal Compiler (FPC): Get the latest version from the FPC website.
  • Lazarus IDE 3.0: Download the latest Lazarus IDE from here.
  • Platform-Specific Requirements:
    • Raspberry Pi: RPi 3+ or newer for optimal performance.
    • Apple M1/M2+: Compatible with Apple Silicon devices.
    • Android/iOS: Set up a development environment (e.g., Android Studio for Android, Xcode for iOS).

Installation

  1. Clone the Repository:
    bash
    git clone https://github.com/ringsce/ekron-realms.git
    cd ekron-realms
  2. Open the Project: Open the .lpi project file in Lazarus IDE.
  3. Configure the Target Platform:
    • Set the project to target your desired platform (e.g., Windows, macOS, Linux, Android, or iOS).
    • Adjust compiler settings if necessary for your platform.
  4. Build the Game: Use the "Build" option in Lazarus IDE to compile the game.
  5. Run and Play: Execute the built file on your system or mobile device to start playing.

Platform-Specific Notes

  • Linux: Ensure SDL2 and other required libraries are installed.
  • Windows: Lazarus automatically includes necessary dependencies; just build and run.
  • macOS: Use the latest version of Xcode to assist with macOS compatibility.
  • Android/iOS: Make sure to have a properly configured environment for mobile development (e.g., Android Studio or Xcode).

Contributing

We encourage developers of all skill levels to contribute! Whether you're fixing bugs, adding features, or enhancing documentation, your efforts are greatly valued.

How to Contribute

  1. Fork the Repository: Create a fork on GitHub.
  2. Create a Branch: Develop your changes on a dedicated branch.
  3. Submit a Pull Request: Open a pull request against the main branch.

For more details, check the CONTRIBUTING.md file.

Areas to Contribute

  • Gameplay Features: Design new levels, maps, or improve AI behavior.
  • Graphics and Sound: Enhance visual and audio assets for an immersive experience.
  • Bug Fixes: Resolve issues reported by the community.
  • Documentation: Help make the project easier to understand for newcomers.

License

Ekron Realms FPS is licensed under the GNU General Public License v3.0. For more information, see the LICENSE file.

Community and Support

Join our community to help shape the future of Ekron Realms FPS:

  • GitHub Issues: Report bugs, request features, or propose ideas.
  • Community Discussions: Share insights and engage with developers and players.
  • Code Contributions: Fork the repository and start coding!

Stay Updated

  • Follow the project on GitHub.
  • Join the development discussions.
  • Stay tuned for new releases and updates.

https://paypal.me/gleentech