revengeday/cyber-circle-creator
revengeday/cyber-circle-creator
2
1
Fork 1
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity Actions

Add installation instructions and acknowledge contributors in README.md

Browse source 
- 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
This commit is contained in:
Ramses Revengeday 2024-11-17 15:29:20 +00:00
parent 217860f4c9
commit e4879af47f
1 changed files with 63 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

69
README.md
View file

@ -1,38 +1,69 @@
![Cyber Circle Creator Logo](https://git.cyberwa.re/revengeday/cyber-circle-creator/raw/branch/main/img/logo.svg)
# Cyber Circle Creator # Cyber Circle Creator
Yo choom! I'm excited to introduce you to [Cyber Circle Creator](https://ccc.cyber.to), a preem tool that I forked and enhanced. It allows you to explore your Fediverse circle with a cyberpunk twist! Yo choom!
## What's It About? 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.
Cyber Circle Creator lets you visualize your Fediverse connections in a dynamic, cyber-futuristic way. Just pop in your Fediverse handle, and watch your network come to life in an interactive diagram. This tool allows you to explore and visualize your Fediverse connections through an interactive diagram.
This tool builds upon [AMNatty/Mastodon-Circles](https://github.com/AMNatty/Mastodon-Circles) and [andigandhi/Mastodon-Circles](https://github.com/andigandhi/Mastodon-Circles), with some enhancements from [noellabo](https://github.com/noellabo/Mastodon-Circles) including Fedibird support. ## Overview
## What Can You Do With It? 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.
- **Visualize Your Network**: Enter your Mastodon or another Fediverse handle to see a graphical display of your connections. 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.
- **Cyberpunk Style**: Enjoy visuals with dynamic lines and intricate, sci-fi-inspired backgrounds.
- **Instant Sharing**: Create a link with your handle to easily share your unique circle with others. ## 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 ## Getting Started
It's super easy to get started! Just head over to [Cyber Circle Creator](https://ccc.cyber.to) and enter your Fediverse handle. For quick access next time, modify the URL directly by appending your handle like so: `https://ccc.cyber.to/?@username@instance.tld`. 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 ## Customization Options
Make it your own with customization features! You can tweak line colors, avatar sizes, and add cool background patterns. Customization is available via the `config` object in `js/image.js`. 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`.
Here's a quick overview of what you can change: Quick customization pointers:
- **`logoSrc`**: Path to your project’s logo image. - **`logoSrc`**: Define the path to your project’s logo image.
- **`backgroundColor`**: Set the background color of your canvas. - **`backgroundColor`**: Set the canvas's background color.
- **`lineColor`**: Choose the color of the connection lines. - **`lineColor`**: Customize the color of the connection lines.
- **Etc.**: There are many more options to play around with if you’re up for some customization. - **And More**: Explore further options to enhance your personalized experience.
## Need Help? ## Need Assistance?
Got questions or need some help? Check out the [FAQ section](https://ccc.cyber.to) on the project site for more info or contact me in the Fediverse. [Fediverse](https://corteximplant.com/@revengeday) 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).
## Contribute! ## Acknowledgments
Interested in contributing? That would be awesome! Feel free to create a fork. Let's see what amazing things you can contribute! 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.