THEZYZSTUDIO commited on
Commit
48d1e9b
·
verified ·
1 Parent(s): c96c845

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +62 -157
README.md CHANGED
@@ -1,161 +1,66 @@
1
  ---
2
- title: The Z AI Agent Minecraft Server
3
- emoji: 🎮
4
- colorFrom: green
5
- colorTo: gray
6
- sdk: docker
 
 
7
  pinned: false
8
  ---
9
 
10
- # 🎮 Minecraft Java Server — Hugging Face Spaces
11
-
12
- > سيرفر Minecraft Java Edition صغير يعمل داخل Docker على Hugging Face Spaces.
13
- > مثالي للعب مع الأصدقاء دون الحاجة لاستضافة مدفوعة.
14
-
15
- ---
16
-
17
- ## ما الذي يفعله هذا المشروع؟
18
-
19
- - يُشغّل **Minecraft Java server** داخل حاوية Docker.
20
- - يُنزّل JAR السيرفر تلقائيًا من Mojang عند أول تشغيل.
21
- - يحفظ عالمك ولوغاتك في `/data` (دائم بين إعادات التشغيل).
22
- - يقبل إعدادات مرنة عبر متغيرات البيئة دون تعديل الكود.
23
-
24
- ---
25
-
26
- ## المتطلبات
27
-
28
- | المتطلب | التفاصيل |
29
- |--------|----------|
30
- | حساب Hugging Face | مجاني على [huggingface.co](https://huggingface.co) |
31
- | Space من نوع Docker | اختر **Docker** عند إنشاء الـ Space |
32
- | Hardware | Space مجاني يكفي للتجربة — CPU basic |
33
- | Minecraft Java Edition | على أجهزة اللاعبين (نسخة مدفوعة) |
34
- | منفذ مفتوح | HF Spaces لا تدعم TCP مباشرة — راجع ملاحظة الشبكة |
35
-
36
- ---
37
-
38
- ## كيفية الرفع إلى Hugging Face
39
-
40
- ```bash
41
- # 1. ثبّت git-lfs إن لم يكن مثبتًا
42
- git lfs install
43
-
44
- # 2. أنشئ Space جديد من نوع Docker على huggingface.co/new-space
45
-
46
- # 3. استنسخ الـ Space الفارغ
47
- git clone https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME
48
- cd YOUR_SPACE_NAME
49
-
50
- # 4. انسخ ملفات هذا المشروع إليه
51
- cp -r /path/to/minecraft-hf-space/* .
52
-
53
- # 5. ارفع
54
- git add .
55
- git commit -m "Initial Minecraft server setup"
56
- git push
57
- ```
58
-
59
- بعد الـ push، سيبني HF الـ Docker image تلقائيًا ويُشغّل السيرفر.
60
-
61
- ---
62
-
63
- ## كيفية تشغيل السيرفر
64
-
65
- بعد رفع الملفات:
66
-
67
- 1. افتح الـ Space على Hugging Face.
68
- 2. انتظر حتى يكتمل البناء (عادةً 2-3 دقائق).
69
- 3. راقب اللوغات من تبويب **Logs** في الـ Space.
70
- 4. عند ظهور `Done! For help, type "help"` — السيرفر شغّال.
71
-
72
- ### الاتصال بالسيرفر ⚠️
73
-
74
- > **تنبيه مهم:** Hugging Face Spaces لا تكشف منافذ TCP خارجيًا تلقائيًا.
75
- > لتمرير المنفذ، استخدم إحدى الطرق التالية:
76
-
77
- | الخيار | التفاصيل |
78
- |--------|----------|
79
- | **playit.gg** | خدمة مجانية لتمرير منفذ Minecraft — الأسهل |
80
- | **ngrok** | يتطلب حساب مجاني، يدعم TCP |
81
- | **Cloudflare Tunnel** | للمستخدمين المتقدمين |
82
-
83
- مثال باستخدام playit.gg داخل الـ container:
84
- ```bash
85
- # أضف في start.sh قبل تشغيل Java:
86
- curl -SsL https://playit.gg/downloads/playit-linux-amd64 -o /tmp/playit
87
- chmod +x /tmp/playit
88
- /tmp/playit &
89
- ```
90
-
91
- ---
92
-
93
- ## كيف أحافظ على العالم محفوظًا؟
94
-
95
- - **العالم يُحفظ في `/data/world`** (أو أي اسم اخترته في `MC_WORLD`).
96
- - `/data` هو الـ volume الدائم في Spaces — البيانات لا تُحذف عند إعادة التشغيل.
97
- - لعمل نسخة احتياطية يدوية: اذهب إلى **Files** في الـ Space وحمّل مجلد `data/world`.
98
-
99
- > ⚠️ إذا **حذفت الـ Space** نفسه، ستُفقد البيانات. احتفظ بنسخة خارجية دائمًا.
100
-
101
- ---
102
-
103
- ## كيف أغيّر الإعدادات؟
104
-
105
- كل الإعدادات الرئيسية تُتحكم بها عبر **Environment Variables** في إعدادات الـ Space:
106
-
107
- | المتغير | الافتراضي | الوصف |
108
- |---------|-----------|-------|
109
- | `MC_VERSION` | `1.21.4` | إصدار Minecraft |
110
- | `MC_MEMORY` | `1G` | الحد الأدنى للـ RAM |
111
- | `MC_MAX_MEMORY` | `2G` | الحد الأقصى للـ RAM |
112
- | `MC_WORLD` | `world` | اسم مجلد العالم |
113
- | `SERVER_PORT` | `25565` | منفذ السيرفر |
114
-
115
- ### طريقة التعديل:
116
- 1. افتح Space ← **Settings** ← **Variables and secrets**
117
- 2. أضف المتغير بالاسم والقيمة المطلوبة.
118
- 3. أعد تشغيل الـ Space.
119
-
120
- ### تغيير إعدادات اللعبة (server.properties):
121
- بعد أول تشغيل، عدّل `/data/server.properties` مباشرة عبر:
122
- - أداة الـ terminal في الـ Space (إن توفرت)
123
- - أو أضف سكريبت يعدّل الملف قبل التشغيل
124
-
125
- ---
126
-
127
- ## هيكل الملفات
128
-
129
- ```
130
- minecraft-hf-space/
131
- ├── Dockerfile # تعريف الحاوية
132
- ├── start.sh # سكريبت التشغيل
133
- ├── README.md # ه��ا الملف
134
- └── config/
135
- └── server.properties.template # قالب الإعدادات
136
- ```
137
-
138
- بعد التشغيل الأول، ستجد في `/data`:
139
- ```
140
- /data/
141
- ├── server.jar # JAR السيرفر (مُخزَّن مؤقتًا)
142
- ├── eula.txt
143
- ├── server.properties
144
- ├── world/ # العالم المحفوظ
145
- └── logs/
146
- ```
147
-
148
- ---
149
-
150
- ## نصائح الأداء
151
-
152
- - **RAM:** على الـ Space المجاني (16GB RAM)، `MC_MAX_MEMORY=3G` جيد لـ 5 لاعبين.
153
- - **view-distance:** قيمة 6-8 تكفي وتوفر CPU.
154
- - **Aikar's flags:** مُضمّنة في `start.sh` لتحسين GC.
155
-
156
- ---
157
-
158
- ## الترخيص
159
-
160
- هذا المشروع لأغراض تعليمية وتجريبية.
161
- Minecraft ملك لـ Mojang/Microsoft — تأكد من امتلاك نسخة أصلية.
 
1
  ---
2
+ title: THE Z AI/AGENT
3
+ emoji: 🤖
4
+ colorFrom: indigo
5
+ colorTo: purple
6
+ sdk: gradio
7
+ sdk_version: "4.44.1"
8
+ app_file: app.py
9
  pinned: false
10
  ---
11
 
12
+ # THE Z AI/AGENT
13
+
14
+ واجهة ذكاء اصطناعي متعددة الأوضاع مبنية للنشر على Hugging Face Spaces.
15
+ # THE Z AI/AGENT Hugging Face + itch.io package
16
+
17
+ هذا المشروع يحتوي على:
18
+ - `index.html` واجهة دردشة جاهزة
19
+ - `prompts/system_prompt.js` البرومبت الأساسي
20
+ - `prompts/coder_prompt.js` برومبت البرمجة الضخم
21
+ - `prompts/tier_prompts.js` أوضاع MINI / NORMAL / PRO / MAX
22
+ - `notifications.js` نظام الإشعارات
23
+ - `app.py` سيرفر Python لنشره على Hugging Face
24
+ - `requirements.txt` التبعيات
25
+ - `Dockerfile` للنشر بالحاوية
26
+
27
+ ## التشغيل محلياً
28
+ 1. ثبّت المتطلبات:
29
+ ```bash
30
+ pip install -r requirements.txt
31
+ ```
32
+ 2. شغّل السيرفر:
33
+ ```bash
34
+ python app.py
35
+ ```
36
+ 3. افتح:
37
+ `http://127.0.0.1:7860`
38
+
39
+ ## متغيرات البيئة
40
+ اختر واحداً من المزودين:
41
+
42
+ ### Groq
43
+ - `GROQ_API_KEY`
44
+ - `GROQ_MODEL` (اختياري)
45
+ - `GROQ_BASE_URL` (اختياري)
46
+
47
+ ### OpenRouter
48
+ - `OPENROUTER_API_KEY`
49
+ - `OPENROUTER_MODEL` (اختياري)
50
+ - `OPENROUTER_BASE_URL` (اختياري)
51
+ - `OPENROUTER_SITE_URL` (اختياري)
52
+ - `OPENROUTER_SITE_NAME` (اختياري)
53
+
54
+ ## النشر على Hugging Face Spaces
55
+ - اختر Space من نوع **Python**.
56
+ - ارفع الملفات كما هي.
57
+ - أضف المتغير السري في Settings.
58
+ - اترك `app.py` كملف التشغيل الرئيسي.
59
+
60
+ ## النشر على itch.io
61
+ - ارفع `index.html` مع مجلد `prompts/` و `notifications.js`.
62
+ - اضبط `window.ZAI_API_URL` داخل `index.html` إذا أردت توجيه الطلبات إلى سيرفر خارجي.
63
+
64
+ ## ملاحظة مهمة
65
+ الواجهة الأمامية لا تحتوي على مفاتيح سرية.
66
+ المفتاح يوضع فقط في السيرفر عبر المتغيرات البيئية.