revengeday
e4879af47f
- Included a detailed installation guide to assist users in setting up Cyber Circle Creator on their own webspace. - Added a section to express gratitude to all contributors with a link to the contributors' activity page. - Made minor enhancements to the description
69 lines
No EOL
3.6 KiB
Markdown
69 lines
No EOL
3.6 KiB
Markdown
|
||
|
||
|
||
# Cyber Circle Creator
|
||
|
||
Yo choom!
|
||
|
||
Welcome to the preem [Cyber Circle Creator](https://ccc.cyber.to), an advanced visualization tool with a cyberpunk twist that I have forked from [AMNatty/Mastodon-Circles](https://github.com/AMNatty/Mastodon-Circles) and enhanced.
|
||
|
||
This tool allows you to explore and visualize your Fediverse connections through an interactive diagram.
|
||
|
||
## Overview
|
||
|
||
Cyber Circle Creator transforms the way you perceive your Fediverse connections into an immersive, cyber-futuristic visualization. Simply input your Fediverse handle, and watch your network unfold dynamically.
|
||
|
||
This project is built upon enhancements from [AMNatty/Mastodon-Circles](https://github.com/AMNatty/Mastodon-Circles), [andigandhi/Mastodon-Circles](https://github.com/andigandhi/Mastodon-Circles), and contributions from [noellabo](https://github.com/noellabo/Mastodon-Circles) including Fedibird support.
|
||
|
||
## Features
|
||
|
||
- **Network Visualization**: Enter your Mastodon or other Fediverse handle to generate a visual representation of your network.
|
||
- **Cyberpunk Aesthetics**: Experience sophisticated designs with dynamic lines and sci-fi-inspired backgrounds.
|
||
- **Easy Sharing**: Easily share your network visual by creating a unique link with your handle.
|
||
|
||
## Getting Started
|
||
|
||
To get started with Cyber Circle Creator, visit [Cyber Circle Creator](https://ccc.cyber.to) and input your Fediverse handle. For direct access, append your handle to the URL in this format: `https://ccc.cyber.to/?@username@instance.tld`.
|
||
|
||
## Installation Guide
|
||
|
||
For those who wish to host Cyber Circle Creator on their own net, follow these steps:
|
||
|
||
1. **Download the Project**
|
||
- Clone the repository via Git:
|
||
```bash
|
||
git clone https://git.cyberwa.re/revengeday/cyber-circle-creator.git
|
||
```
|
||
- Alternatively, download it as a ZIP or tarball:
|
||
- [Download ZIP](https://git.cyberwa.re/revengeday/cyber-circle-creator/archive/main.zip)
|
||
- [Download tar.gz](https://git.cyberwa.re/revengeday/cyber-circle-creator/archive/main.tar.gz)
|
||
|
||
2. **Upload Files**
|
||
- Once downloaded, upload the contents of the project to your preferred webspace.
|
||
- Make sure your hosting service supports basic HTML/CSS/JavaScript execution.
|
||
|
||
3. **Access The Tool**
|
||
- Navigate to the uploaded directory's `index.html` file in your browser to access Cyber Circle Creator.
|
||
|
||
## Customization Options
|
||
|
||
Tailor the tool to your liking with various customization features available. Adjust line colors, avatar sizes, and more via the `config` object in `js/image.js`.
|
||
|
||
Quick customization pointers:
|
||
|
||
- **`logoSrc`**: Define the path to your project’s logo image.
|
||
- **`backgroundColor`**: Set the canvas's background color.
|
||
- **`lineColor`**: Customize the color of the connection lines.
|
||
- **And More**: Explore further options to enhance your personalized experience.
|
||
|
||
## Need Assistance?
|
||
|
||
For additional information or support, please visit the [FAQ section](https://ccc.cyber.to) on the project site or connect with me on the Fediverse at [corteximplant.com/@revengeday](https://corteximplant.com/@revengeday).
|
||
|
||
## Acknowledgments
|
||
|
||
A big thank you to all contributors who have helped shape the Cyber Circle Creator. You can find the list of contributors [here](https://git.cyberwa.re/revengeday/cyber-circle-creator/activity/contributors).
|
||
|
||
## Contributions Welcome!
|
||
|
||
Contributions are highly encouraged! Feel free to fork the repository and propose changes. Your insights and improvements are invaluable to the growth of Cyber Circle Creator. |