Skip to content

Commit 5688379

Browse files
committed
docs: Enhance SEO with improved README, metadata files, and troubleshooting guide
1 parent f2a707b commit 5688379

File tree

8 files changed

+135
-7
lines changed

8 files changed

+135
-7
lines changed

CITATION.cff

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
cff-version: 1.2.0
2+
title: "SCCharacters - BioMetrics System"
3+
message: "If you use this software, please cite it as below."
4+
type: software
5+
authors:
6+
- given-names: "SpielerWAN"
7+
family-names: ""
8+
email: "contact@spielerwan.com"
9+
repository-code: "https://github.com/Spieler1ONE1/SCCharacters"
10+
url: "https://github.com/Spieler1ONE1/SCCharacters"
11+
abstract: "An advanced desktop application for managing, installing, and customizing Star Citizen character appearances (.chf files). Features include DNA preset management, backup/restore, and community sharing integration."
12+
keywords:
13+
- "star citizen"
14+
- "character customization"
15+
- "game utility"
16+
- "python"
17+
- "pyside6"
18+
- "biometrics"
19+
- "chf file"
20+
- "gaming tool"
21+
license: MIT
22+
version: 2.0.0
23+
date-released: 2024-05-20

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ First off, thanks for taking the time to contribute! 🎉
44

55
The following is a set of guidelines for contributing to SCCharacters and its packages. These are mostly guidelines, not rules. Use your best judgment and feel free to propose changes to this document in a pull request.
66

7+
## Technology Stack
8+
9+
This project is built using:
10+
- **Python 3.10+**: Core logic and backend.
11+
- **PySide6 (Qt for Python)**: Modern, responsive GUI framework.
12+
- **Star Citizen File Parsing**: Custom handlers for `.chf` and `.xml` configuration files.
13+
14+
We welcome contributions from developers of all skill levels interested in **game tools development**, **GUI programming**, or **Star Citizen community projects**.
15+
716
## Code of Conduct
817

918
This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.

README.md

Lines changed: 41 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
1-
# 🧬 BioMetrics System & Manager
2-
> *Advanced Character Identity Management for Star Citizen*
3-
4-
![Version](https://img.shields.io/badge/version-2.0.0-blue.svg) ![Platform](https://img.shields.io/badge/platform-Windows-blue) ![Star Citizen](https://img.shields.io/badge/Star%20Citizen-Ready-orange) [![Discord](https://img.shields.io/badge/Discord-Join%20Us-5865F2?logo=discord&logoColor=white)](https://discord.gg/TGjCmzHR)
1+
<div align="center">
2+
<img src="assets/logo.png" alt="Star Citizen Character Manager Logo" width="200">
3+
<h1>🧬 BioMetrics - Star Citizen Character Manager</h1>
4+
<h3><i>The Ultimate Character Customization & DNA Preset Tool for Star Citizen</i></h3>
5+
<br>
6+
7+
![Version](https://img.shields.io/badge/version-2.0.0-blue.svg) ![Platform](https://img.shields.io/badge/platform-Windows-blue) ![Star Citizen](https://img.shields.io/badge/Star%20Citizen-Ready-orange) [![Discord](https://img.shields.io/badge/Discord-Join%20Us-5865F2?logo=discord&logoColor=white)](https://discord.gg/TGjCmzHR)
8+
</div>
59

6-
**SCCharacters (BioMetrics)** is a powerful, immersive desktop application designed to streamline the management, installation, and customization of your Star Citizen character appearances (`.chf` files). Built with a modern, sci-fi aesthetic that mirrors the in-game universe, this tool serves as your personal extensive biometric database.
10+
**SCCharacters (BioMetrics)** is a powerful, immersive desktop application designed to streamline the management, installation, and customization of your **Star Citizen character appearances** (`.chf` files). Whether you're looking to **import character presets**, backup your **Star Citizen DNA**, or share your avatar with the community, this tool serves as your personal extensive biometric database. It simplifies the process of changing your in-game appearance without manually editing files.
711

812
---
913

1014
## 🖼️ Interface Gallery
1115

1216
<div align="center">
13-
<img src="assets/screenshots/dashboard.png" alt="Dashboard" width="800">
17+
<img src="assets/screenshots/dashboard.png" alt="Star Citizen Character Manager Dashboard UI" width="800">
1418
<br><br>
15-
<img src="assets/screenshots/splash_screen.png" alt="Splash Screen" width="400">
19+
<img src="assets/screenshots/splash_screen.png" alt="BioMetrics Tool Splash Screen" width="400">
1620
</div>
1721

1822
---
@@ -33,6 +37,20 @@
3337
- Windows 10/11
3438
- Star Citizen installed (LIVE/PTU)
3539

40+
41+
42+
## 🎮 Game Compatibility & Support
43+
44+
**BioMetrics** is updated regularly to support the latest Star Citizen patches.
45+
46+
| Star Citizen Patch | BioMetrics Version | Status |
47+
| :--- | :--- | :--- |
48+
| **Alpha 3.24+** | v2.0.0+ | ✅ Fully Supported |
49+
| **Alpha 3.23** | v1.5.0 | ⚠️ Partial Support |
50+
| **Alpha 3.18 - 3.22** | Legacy | ❌ Deprecated |
51+
52+
*Compatible with LIVE, PTU, and EPTU environments.*
53+
3654
### Installation
3755

3856
<div align="center">
@@ -59,6 +77,22 @@
5977

6078
---
6179

80+
## ❓ Frequently Asked Questions (FAQ)
81+
82+
### How do I install Star Citizen character presets?
83+
Simply download the **BioMetrics Manager**, browse the online repository tab, and click "Install" on any character you like. The tool handles the file placement automatically.
84+
85+
### Where are Star Citizen character files located?
86+
Star Citizen stores character files in `StarCitizen\LIVE\user\client\0\CustomCharacters`. BioMetrics detects this path automatically so you don't have to find it yourself.
87+
88+
### Can I share my Star Citizen character DNA?
89+
Yes! Use the **Backup** feature to export your character to a file, which you can then share with friends or the community.
90+
91+
### Is this tool safe to use with Star Citizen?
92+
Yes, this tool only manages local `.chf` files (character presets) and does not modify game memory or executable files. It is compliant with the Star Citizen Fandom FAQ.
93+
94+
---
95+
6296
## 💬 Community
6397

6498
Join our growing community on Discord to share your characters, ask for help, or discuss features:

SECURITY.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We recommend using the latest version of SCCharacters (BioMetrics) to ensure optimal security and feature compatibility with the latest Star Citizen patch.
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| 2.0.x | :white_check_mark: |
10+
| 1.x.x | :x: |
11+
12+
## Reporting a Vulnerability
13+
14+
SCCharacters is a fan-made tool intended for local file management (`.chf` files). It does not interact with game memory or network packets directly, minimizing most security risks associated with game modification tools.
15+
16+
However, if you discover a security vulnerability within the application itself (e.g., potential for malicious file handling):
17+
18+
1. Please **do not** open a public issue.
19+
2. Email `security@spielerwan.com` or send a DM via our [Discord Server](https://discord.gg/TGjCmzHR).
20+
3. We will acknowledge your report within 48 hours and provide an estimated timeline for a fix.
21+
22+
### Safe Usage Guidelines
23+
24+
To ensure your Star Citizen account safety and PC security:
25+
26+
* **Only download SCCharacters from official sources:**
27+
* [Official GitHub Releases](https://github.com/Spieler1ONE1/SCCharacters/releases)
28+
* **Verify Character Files:** When importing `.chf` files from unknown sources, ensure they are valid Star Citizen character files. SCCharacters includes basic validation, but caution is always advised.
29+
* **Anti-Cheat Compliance:** This tool operates strictly within the bounds of the [Star Citizen Fandom FAQ](https://support.robertsspaceindustries.com/hc/en-us/articles/360006895793-Star-Citizen-Fankit-and-Fandom-FAQ). It modifies user-accessible configuration files only and is safe to use with Easy Anti-Cheat (EAC).

assets/logo.png

304 KB
Loading

docs/TROUBLESHOOTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# 🔧 Troubleshooting Guide for Star Citizen Character Import
2+
3+
Common issues and solutions for managing your Star Citizen character DNA with BioMetrics.
4+
5+
## ⚠️ "Character Not Found" in Game
6+
7+
**Problem:** You installed a character, but it doesn't appear in the Character Customization screen inside Star Citizen.
8+
9+
**Solutions:**
10+
1. **Check Game Mode:** BioMetrics supports LIVE, PTU, and EPTU. Ensure you selected the correct environment in the settings.
11+
2. **Restart the Game:** Star Citizen loads character files at startup or when entering the character creator. A restart is often required.
12+
3. **Verify Path:** Go to `Settings` in BioMetrics and check if the *Star Citizen Installation Path* is correct (e.g., `C:\Program Files\Roberts Space Industries\StarCitizen`).
13+
14+
## 🚫 "Access Denied" Error
15+
16+
**Problem:** The application cannot write to the `CustomCharacters` folder.
17+
18+
**Solutions:**
19+
1. **Run as Administrator:** Right-click `SCCharacters.exe` and select "Run as Administrator".
20+
2. **Check Folder Permissions:** Ensure your Windows user has write permissions to the Star Citizen directory.
21+
3. **Antivirus Interference:** Add `SCCharacters.exe` to your antivirus exclusion list.
22+
23+
## 🧬 Corrupted Character File (.chf)
24+
25+
**Problem:** A character preset causes the game to crash or look distorted.
26+
27+
**Solutions:**
28+
1. **Delete the File:** In BioMetrics, go to the "Installed" tab and delete the problematic character.
29+
2. **Verify Integrity:** Use the "Verify Files" option in the RSI Launcher to repair your game installation if crashes persist.
30+
31+
## 🐞 Reporting Bugs
32+
33+
If your issue isn't listed here, please [open an issue on GitHub](https://github.com/Spieler1ONE1/SCCharacters/issues) with your log file attached.

src/assets/icons/app_icon.ico

209 KB
Binary file not shown.

src/assets/icons/app_icon.png

-234 KB
Loading

0 commit comments

Comments
 (0)