README

Within Rune's architecture, Ether defines truth, Essence holds flow, and Entity performs behavior - each awakened only when invoked. Every element is crafted to be composable, lazy-loaded, and purpose-driven, making systems naturally scalable and precise.

This makes Rune inherently lightweight and adaptable, aligning perfectly with projects that evolve from concept, not convention. Whether shaping internal tools, backend systems, or modular workflows, Rune empowers developers to sculpt structure from intent, not instruction.

Essentials

Core System

Modular Core Structure & Concept (Maintainable)
Functional Process-Based
Lazy Loading without Bootstrapping
Live Documentation / Reflection Core (Phantasm)
Automatic Minor & Patch Versioning
PSR-4 Composer Autoloading
Static Class Service Handler
Dynamic Output Structure

Developer Space

Stats Information (Main Entrance)
Dynamic Command List (Main Entrance)
System Inspection & Read (Grimoire)
Phased Process Log (Arcane) (Grimoire)
Execution Result: Timestamp, Memory & Peak Memory
Fancy Command Line Interface (100% CLI support)
Save & Load Project as Package (Runite) (Artefact)
Project Item as Package (Shard) (Artefact)
Metadata Storage & Handling .echoes (Keeper)
Zero Trust for Breaking Execution
Event-Driven & Encapsulation (Chanter)
Starter Template (Awakening)
Command Line UI & Interaction (Chanter & Whisper)
Text Styling & Reuse (Weaver)
File/Item & Directory/Repo Handling (Forger)
Fancy Error Handling (Keeper)
Process-Focusable (Whisper.drain)
Multi-Process & Interaction (Specter)
Open All Possibilities & Potential (Liberation)

Awakening

Install Rune using Composer:

composer require devneet/rune

Create main file:

echo "#rune" > cast

First invocation awaken Rune from the void:

<?php
/*
 * Act. 0 - Awaken From The Void
 * THE VOID
 *
 * From the silence of nothingness, echoes rise from the void.
 * A journey begins - with runes at your side.
 * 
 * */
require_once __DIR__ . '/vendor/autoload.php';

Rune\Ethereal::awakening();

Run the app to begin:

php cast

Explore the system’s using the Grimoire:

php cast grimoire

Paradigm

At first, humans did not know anything.
Then how did they start to know things, and learn more about them?

By looking, writing, and growing, we can finally understand.

Core

Rune = something we don't know yet
Ethereal = a place or thing we don't know

Subject

Ether = something that never changes but always has meaning
Essence = something that can change as time goes on
Entity = something that makes other things change
Manifest = a box to connect things so they can work together
Phantasm = a picture in our mind to understand

Others

Awakening = starting something, from anywhere
Liberation = being free and making something new
Echoes = sounds from the past
Runite = a rune that becomes a thing
Shard = a small piece of runite
Bindrune = many runes joined together
Grimoire = a book that feels alive
Sentinel = someone or something that guards
Artefact = a thing we can see

Contributing

Thank you for considering contributing to the Rune! The contribution guide can be found in the Rune Contribution.

Code of Conduct

In order to ensure that the DEVNEET community is welcoming to all, please review and abide by the Code of Conduct.

License

The Rune is open-sourced software licensed under the MIT license.

devneet / rune

Maintainers

Details