Move repo from git to gitea

Signed-off-by: Boris Yumankulov <boria138@altlinux.org>
This commit is contained in:
2025-06-01 15:21:32 +05:00
parent aae1ce9c10
commit abec9bbef8
110 changed files with 545106 additions and 2 deletions

View File

@ -0,0 +1,110 @@
📘 Эта документация также доступна на [русском](README.ru.md)
---
## 📋 Contents
- [Overview](#overview)
- [How It Works](#how-it-works)
- [Data Priorities](#data-priorities)
- [File Structure](#file-structure)
- [For Users](#for-users)
- [Creating User Overrides](#creating-user-overrides)
- [Example](#example)
- [For Developers](#for-developers)
- [Adding Built-In Overrides](#adding-built-in-overrides)
---
## 📖 Overview
In `PortProtonQT`, you can change:
- Game title
- Description
- Cover image
Override types:
| Type | Location | Priority |
|-----------------|--------------------------------------------------|----------|
| User | `~/.local/share/PortProtonQT/custom_data/` | Highest |
| Built-in | `portprotonqt/custom_data/` | Lower |
---
## ⚙️ How It Works
### Data Priorities
Data is used in the following order:
1. **User Overrides**
2. **Built-in Overrides**
3. **Steam Metadata**
4. **`.desktop` file info**
### File Structure
Each `<exe_name>` folder can include:
- `metadata.txt` — contains name and description:
```txt
name=My Game Title
description=My Game Description
```
- `cover.<extension>` — image file (`.png`, `.jpg`, `.jpeg`, `.bmp`)
---
## 👤 For Users
### Creating User Overrides
1. **Create a folder for your game**:
```bash
mkdir -p ~/.local/share/PortProtonQT/custom_data/mygame
```
2. **Add overrides**:
- **Metadata file**:
```bash
echo -e "name=My Game\ndescription=Exciting game" > ~/.local/share/PortProtonQT/custom_data/mygame/metadata.txt
```
- **Cover image**:
```bash
cp ~/Images/custom_cover.png ~/.local/share/PortProtonQT/custom_data/mygame/cover.png
```
3. **Restart PortProtonQT**.
## 🛠 For Developers
### Adding Built-In Overrides
1. **Create a folder in the project**:
```bash
mkdir -p portprotonqt/custom_data/mygame
```
2. **Add files**:
- `metadata.txt`:
```txt
name=Default Title
description=Default Description
```
- Cover image (`cover.png`, for example):
```bash
cp path/to/cover.png portprotonqt/custom_data/mygame/cover.png
```
3. **Commit changes to repository**:
```bash
git add portprotonqt/custom_data/mygame
git commit -m "Added built-in overrides for mygame"
```
---
> Done! Your games will now look exactly how you want 🎮✨

View File

@ -0,0 +1,110 @@
📘 This documentation is also available in [English](README.md)
---
## 📋 Содержание
- [Обзор](#обзор)
- [Как это работает](#как-это-работает)
- [Приоритеты данных](#приоритеты-данных)
- [Структура файлов](#структура-файлов)
- [Для пользователей](#для-пользователей)
- [Создание пользовательских переопределений](#создание-пользовательских-переопределений)
- [Пример](#пример)
- [Для разработчиков](#для-разработчиков)
- [Добавление встроенных переопределений](#добавление-встроенных-переопределений)
---
## 📖 Обзор
В `PortProtonQT` можно изменить:
- Название игры
- Описание
- Обложку
Типы переопределений:
| Тип | Расположение | Приоритет |
|----------------|---------------------------------------------------|-----------|
| Пользовательские | `~/.local/share/PortProtonQT/custom_data/` | Высший |
| Встроенные | `portprotonqt/custom_data/` | Ниже |
---
## ⚙️ Как это работает
### Приоритеты данных
Данные берутся в следующем порядке:
1. **Пользовательские переопределения**
2. **Встроенные переопределения**
3. **Данные Steam**
4. **Информация из `.desktop` файла**
### Структура файлов
В каждой папке `<имя_exe>` могут быть следующие файлы:
- `metadata.txt` — имя и описание в формате:
```txt
name=Моё название игры
description=Описание моей игры
```
- `cover.<расширение>` — обложка (`.png`, `.jpg`, `.jpeg`, `.bmp`)
---
## 👤 Для пользователей
### Создание пользовательских переопределений
1. **Создайте папку для игры**:
```bash
mkdir -p ~/.local/share/PortProtonQT/custom_data/mygame
```
2. **Добавьте переопределения**:
- **Файл метаданных**:
```bash
echo -e "name=Моя игра\ndescription=Захватывающая игра" > ~/.local/share/PortProtonQT/custom_data/mygame/metadata.txt
```
- **Обложку**:
```bash
cp ~/Images/custom_cover.png ~/.local/share/PortProtonQT/custom_data/mygame/cover.png
```
3. **Перезапустите PortProtonQT**.
## 🛠 Для разработчиков
### Добавление встроенных переопределений
1. **Создайте папку в проекте**:
```bash
mkdir -p portprotonqt/custom_data/mygame
```
2. **Добавьте файлы**:
- `metadata.txt`:
```txt
name=Стандартное название
description=Стандартное описание игры
```
- Обложка (`cover.png`, например):
```bash
cp path/to/cover.png portprotonqt/custom_data/mygame/cover.png
```
3. **Добавьте изменения в репозиторий**:
```bash
git add portprotonqt/custom_data/mygame
git commit -m "Добавлены встроенные переопределения для mygame"
```
---
> Готово! Теперь ваши игры будут выглядеть именно так, как вы хотите 🎮✨