Sentient-Eye-Engine/ReadMe.txt at main · Sentient-LabsDev/Sentient-Eye-Engine · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
=========================================================================
                    SENTIENT EYE ENGINE (v1.0)
             Developed by: Sentient Labs / E.R.D. Interactive
=========================================================================

> "We don't just render pixels; we forge digital souls."

PROJECT OVERVIEW
-------------------------------------------------------------------------
Sentient Eye Engine is a procedural (mathematical) and physics-based
robot eye animation engine, inspired by the disassembly drones from the
Murder Drones universe. Instead of using static images/sprites, it utilizes
real-time calculated muscle systems and bio-digital reactions to create
life-like expressions.

FILE STRUCTURE & CONTENT
-------------------------------------------------------------------------
This directory contains the core files required for the engine to run:

[📂 FILES]
* Main.py ........: LAUNCH ENGINE. The main file that runs the simulation,
                    physics, and facial tracking systems.
* Editor.py ......: DESIGN FACTORY. Run this to draw new emotions, sculpt
                    brows, and modify the eye using 'Surgery Mode'.
* Config.py ......: SETTINGS. Screen resolution, color palette, and system
                    constants.

[📂 DIRECTORIES]
* Modules/ .......: THE BRAIN. (contains face_renderer.py, etc.).
                    All mathematical calculations and rendering logic happen here.
* assets/ ........: STORAGE.
    - /eyes: Reference images for the editor.
    - /data: Your saved .json emotion data.
* Tools/ .........: TOOLKIT. (extractor.py, etc.)
                    Tools for cutting and processing reference images.
* __pycache__/ ...: CACHE. Files automatically generated by Python for faster
                    execution. No need to touch; can be deleted safely.

INSTALLATION (HOW TO RUN?)
-------------------------------------------------------------------------
1. Ensure Python is installed on your system.
2. Install the required libraries via terminal/command prompt:
   >> pip install pygame opencv-python mediapipe numpy

3. To design a new emotion:
   >> python Editor.py

4. To start the System and AI:
   >> python Main.py

-------------------------------------------------------------------------
(C) 2025 Sentient Labs. Open Source Project.