Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dna-styx/hlstatsx-windmill-theme

Responsive reskinning based on StartersClan's HLStats:CE v1.11.3
https://github.com/dna-styx/hlstatsx-windmill-theme

discord hlstatsx hlstatsx-community-edition hlstatsxce mumble teamspeak3 theme

Last synced: 25 days ago
JSON representation

Responsive reskinning based on StartersClan's HLStats:CE v1.11.3

Host: GitHub
URL: https://github.com/dna-styx/hlstatsx-windmill-theme
Owner: DNA-styx
Created: 2024-09-21T20:21:32.000Z (4 months ago)
Default Branch: main
Last Pushed: 2024-12-06T22:50:32.000Z (about 1 month ago)
Last Synced: 2024-12-06T23:23:25.353Z (about 1 month ago)
Topics: discord, hlstatsx, hlstatsx-community-edition, hlstatsxce, mumble, teamspeak3, theme
Language: PHP
Homepage:
Size: 1.34 MB
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 11
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        





    

  


  

  

  

  

  

HLStatsx:CE Windmill Dashboard Theme


  


    Responsive HLStatsx:CE Theme

    


    


    View Live Demo

    ·

    Report a Bug

    ·

    Request Feature

  



## About The Theme

![image](https://github.com/user-attachments/assets/c08984e9-fe68-4c20-84d4-04c353b9822f)

HLStatsx:CE Theme built using StarterClan v1.11.3 fork with [Windmill Dashboard CSS](https://github.com/estevanmaito/windmill-dashboard) applied on top. 

Some default HLStatsx:CE features have been removed to simplify the interface and make it small screen friendly.

Features enabled

* Dark and light theme switcher

* Responsive design for small and large screens

* Custom CSS colours are set site wide using the admin page, use the defaults or create your own

* Links menu

* TeamSpeak3 server status and browser using serverquery [ details ]

* TeaSpeak & Mumble basic support added

* Discord Voice Channel Support [ details ]

* Steam Group Chat Support [ details ]  

* Top of page banners

* InGame Pages

Features not/still to be Enabled

* TeamSpeak1 & Ventrillo server status

* Hitbox graphs

* Forum signatures

* Most server load graphs

* Player page tabs

* Style selector (admins set the colour of their site, not visitors)

(back to top)


## Screenshots

View Live Demo

(back to top)


### Prerequisites

* Working HLStatsX:CE by [StarterClan v1.11.3](https://github.com/startersclan/hlstatsx-community-edition). May work with others. Please let me know and I'll update the docs.

* FTP or cpanel access to upload files to the web server.

(back to top)


### Known issues

* If text does not display on a page, click the sun icon theme switcher top right to make it visable and [open an issue](https://github.com/DNA-styx/HLSTATSX-Windmill-Theme/issues).

See the [open issues](https://github.com/DNA-styx/HLSTATSX-Windmill-Theme/issues) for known issues and feature requests.

(back to top)


### Installation

1. Download the [latest release](https://github.com/DNA-styx/HLSTATSX-Windmill-Theme/releases) - Not recommended until first beta release as files may contain bugs and codebase/file structure may change regularly.

   

or Download all files from repository (Code -> Download zip) - 

3. (soon)

4. (soon)

5. (soon)

(back to top)


## Upgrade

Download, unzip and overwrite all files from that .zip into the root of your web server.

(back to top)


## Return to default theme

Each release includes an archive, called default-hlstatsx-files-(release-number).zip, of all the uneditted default HLStatsX files used in this theme.

To return to using the default HLStatsx theme copy these files to your web server overwiting the custom ones.    

(back to top)


## Roadmap

- [X] Public pages

  - [X] Basic theme applied 

  - [X] Usable on large screen 

  - [X] Usable on small screen

- [ ] Admin pages 

  - [ ] Basic theme applied 

  - [ ] Usable on large screen  

  - [ ] Usable on small screen

- [ ] Beta release 

- [ ] Fully themed and old code replaced 

- [ ] Remove all old/unused CSS, js and files

- [ ] Code tidy up

- [ ] Full Release

(back to top)


## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request

(back to top)


## Acknowledgments

* [Estevanmaito's Windmill Dashboard](https://github.com/estevanmaito/windmill-dashboard) for the underlying css design code

* [StartersClan HLStatsX:CE](https://github.com/startersclan/hlstatsx-community-edition) for the base page code

* [Eska](https://forums.alliedmods.net/showpost.php?p=1854304&postcount=4) for inital TeamSpeak3 work (and @stive101 for letting me know)

* [ts3admin.class](https://github.com/Speckmops/ts3admin.class) for the TeamSpeak3 server query

* [scheissegalo](https://github.com/scheissegalo/PHP-TS3ServerViewer) for the TeamSpeak3 server browser code

* [Mizu](https://www.myteamspeak.com/addons/author/Mizu) & [Gox11](https://www.myteamspeak.com/addons/author/Gox11) for their TeamSpeak3 icon packs

* [Shoelace](https://shoelace.style/) for the tree view component used in the TeamSpeak3 server browser

* [Lemehost](https://lemehost.com/i/4tqeRx) (aff. link) for the free TeamSpeak3 server for testing

* [Monochromatic](https://stackoverflow.com/questions/47454876/get-total-number-of-members-in-discord-using-php/74583912#74583912) for the easy Discord Voice Channel staus tip

(back to top)


## Links

* HLStatsX:CE forum on AlliedMods https://forums.alliedmods.net/forumdisplay.php?f=156

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/DNA-styx/sbpp-windmill-dashboard.svg?style=for-the-badge

[contributors-url]: https://github.com/DNA-styx/sbpp-windmill-dashboard/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/DNA-styx/sbpp-windmill-dashboard.svg?style=for-the-badge

[forks-url]: https://github.com/DNA-styx/sbpp-windmill-dashboard/network/members

[stars-shield]: https://img.shields.io/github/stars/DNA-styx/sbpp-windmill-dashboard.svg?style=for-the-badge

[stars-url]: https://github.com/DNA-styx/sbpp-windmill-dashboard/stargazers

[issues-shield]: https://img.shields.io/github/issues/DNA-styx/sbpp-windmill-dashboard.svg?style=for-the-badge

[issues-url]: https://github.com/DNA-styx/sbpp-windmill-dashboard/issues

[license-shield]: https://img.shields.io/github/license/DNA-styx/sbpp-windmill-dashboard.svg?style=for-the-badge

[license-url]: https://github.com/DNA-styx/sbpp-windmill-dashboard/blob/master/LICENSE.txt