jollywhoppers.com
A Minecraft Fabric mod that connects the game with ATProtocol ⛏️
chore: add initial README
ewancroft.uk
+110
README.md
+110
README.md
···
1
+
# atproto-connect
2
+
3
+
A Fabric mod for Minecraft 1.21.10 that bridges the game with the AT Protocol, enabling decentralized data synchronization and social features.
4
+
5
+
## ⚠️ Project Status
6
+
7
+
**This project is in early planning stages and is NOT ready for production use.** The current repository contains a Fabric mod template to establish the initial project structure. Active development and implementation are ongoing.
8
+
9
+
## Overview
10
+
11
+
atproto-connect aims to integrate Minecraft gameplay with the AT Protocol (the protocol powering Bluesky), allowing game data to be synced to AT Protocol lexicons. This enables decentralized storage and sharing of Minecraft data across the federated network.
12
+
13
+
## Goals
14
+
15
+
- **Decentralized Data Sync**: Publish Minecraft gameplay data to AT Protocol repositories
16
+
- **Cross-Server Statistics**: Enable player statistics to persist across different servers via AT Protocol
17
+
- **Social Integration**: Connect Minecraft achievements and activities with the broader AT Protocol ecosystem
18
+
- **Lexicon-Based Storage**: Utilize AT Protocol's schema system for structured game data
19
+
20
+
## Use Cases
21
+
22
+
### Player Statistics & Leaderboards
23
+
24
+
Sync player statistics (blocks mined, mobs killed, distance traveled, etc.) to AT Protocol lexicons, enabling:
25
+
26
+
- Global leaderboards that work across multiple servers
27
+
- Historical stat tracking independent of individual server databases
28
+
- Player achievement portfolios visible on AT Protocol clients
29
+
30
+
### Future Possibilities
31
+
32
+
- Server announcements via AT Protocol feeds
33
+
- Cross-server player reputation systems
34
+
- Decentralized mod/plugin distribution
35
+
- In-game social features tied to AT Protocol identities
36
+
37
+
## Technical Stack
38
+
39
+
- **Minecraft Version**: 1.21.10
40
+
- **Mod Loader**: Fabric API
41
+
- **Protocol**: AT Protocol (atproto)
42
+
- **Language**: Kotlin (with Java interop)
43
+
44
+
## Installation
45
+
46
+
### For Users
47
+
48
+
*Installation instructions will be added once the mod reaches a usable state.*
49
+
50
+
### For Developers
51
+
52
+
Clone the repository:
53
+
54
+
```bash
55
+
git clone git@tangled.sh:ewancroft.uk/atproto-connect
56
+
cd atproto-connect
57
+
```
58
+
59
+
Build the project:
60
+
61
+
```bash
62
+
./gradlew build
63
+
```
64
+
65
+
## Development Roadmap
66
+
67
+
- [ ] Design lexicon schemas for Minecraft data types
68
+
- [ ] Implement AT Protocol client integration
69
+
- [ ] Create configuration system for AT Protocol credentials
70
+
- [ ] Build data collection hooks for player statistics
71
+
- [ ] Develop sync engine for pushing data to AT Protocol
72
+
- [ ] Add privacy controls and data filtering options
73
+
- [ ] Create example lexicons and test environments
74
+
- [ ] Write comprehensive documentation
75
+
76
+
## Architecture (Planned)
77
+
78
+
```plaintext
79
+
Minecraft Server (Fabric)
80
+
↓
81
+
atproto-connect Mod
82
+
↓
83
+
AT Protocol Client Library
84
+
↓
85
+
AT Protocol PDS (Personal Data Server)
86
+
↓
87
+
Federated AT Protocol Network
88
+
```
89
+
90
+
## Contributing
91
+
92
+
As this project is in early development, contribution guidelines will be established once the core architecture is defined. If you're interested in contributing, please open an issue to discuss your ideas.
93
+
94
+
## AT Protocol Resources
95
+
96
+
- [AT Protocol Documentation](https://atproto.com/)
97
+
- [Lexicon Specifications](https://atproto.com/specs/lexicon)
98
+
- [AT Protocol SDKs](https://atproto.com/sdks)
99
+
100
+
## License
101
+
102
+
License information to be added.
103
+
104
+
## Disclaimer
105
+
106
+
This is an experimental project exploring the intersection of decentralized protocols and gaming. It is not affiliated with or endorsed by Mojang, Microsoft, or the official AT Protocol team.
107
+
108
+
---
109
+
110
+
**Repository**: `git@tangled.sh:ewancroft.uk/atproto-connect`