3

GitHub - savioxavier/discord-neofetch: Display your Discord information - neofet...

 2 years ago
source link: https://github.com/savioxavier/discord-neofetch
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

discord-neofetch

View your Discord information, neofetch style!

Add to your server

Please note that this bot might be unstable at times. If you do find any problems, feel free to open a new issue

Here's a demo of the bot

Demo
  • Hmm. What's this?

This is the Neofetch bot, a really cool bot that allows you to view your Discord information, right in Discord, neofetch style. Complete with fully customizable prompts and ascii distros, this is every developer's dream come true.

  • Why would I even need this?

Because everybody absolutely loves Neofetch, a command-line tool that displays your system information. This bot is a hobby project of mine, and I, inspired by the orginal CLI tool, wanted to make a visual Discord version of it.

Also you get to show off your favorite distro (looking at you arch btw users).

  • How does it even work?

Alright, so Discord recently added ANSI escape codes to codeblock messages, which means that you can 'colorize' your output an style it whichever way you want. This bot takes advantage of this feature, and works around with the color codes using chalk to produce a neofetch-like colored output.

Unfortunately, mobile support for ANSI codes haven't been added yet, but fear not! There's a button called --mobile that outputs a mobile friendly view of the information. Alternatively, you can use the /neomobile command too!

  • What sort of information is displayed?

Here's a list of the information that is displayed:

Name Description
Username The author/user's tag (eg: Wumpus#0001)
ID The author/user's unique Discord ID
Created The date on which the user/author's account was created
Is Bot Checks if the user/author is a bot
CPU Usage* CPU Usage count, similar to neofetch
Shell* Distro specific shell
Packages* Package count, with the appropriate distro specific package manager

Fields marked with a * are randomized values and do not directly depend on the Discord API

  • What distros are supported?

Here's a list of distros that this bot supports. Choose any one you'd like:

Name Value
Discord (Default) discord
Arch Linux arch
Fedora fedora
Manjaro manjaro
Mint mint
Pop!_OS popos
Ubuntu ubuntu
Android android
CentOS centos
Debian debian
Elementary elementary
Gentoo gentoo
MacOS macos
Windows windows

All the above distros and their ascii arts have been ported from dylanaraps/neofetch.

  • What prompts are supported?

Here's a list of prompts that this bot supports. Choose any one you'd like:

Name Value
Default (Default) default
Pristine pristine
AFMagic afmagic
Candy candy
Zap zap
Percent percent
Wuffers wuffers

All the above prompts have been ported from ohmyzsh/ohmyzsh.

  • What commands are available?

Here's a list of commands that are available:

Command Description
/neofetch The main neofetch command.
Used to display the neofetch-ed information of the author
or the user mentioned, in accordance with their set distro and prompt.
Also displays a set of neofetch-like, non-Discord related info,
such as the number of packages, shell, etc.
/neomobile A mobile version of the neofetch command.
/neoconf distro Customize your distro from a list of options.
/neoconf prompt Customize your prompt from a list of options.
/info Display relevant information about the bot.
/help View a list of bot commands.
/invite Display an invite link to add your bot to your server.
  • Are there slash commands?

Absolutely! Check them out by typing in /help. Legacy commands aren't supported though, as they have been deprecated.

  • Cool bot, can I add it to my server?

Of course you can! Just click this link and select the server of your choice.

  • Why is the code so bad?

Because we need you! A number of contributors are helping to expand and improve the code base. Why don't you join us?

  • How can I contribute?

Just check out the Issues pane for potential issues and submit a PR to solve them. Of course, you can always contribute to the inprovement of the code, and I'd be happy to accept your PRs!

Support

You can support further development of this bot by giving it a star2 and help me make even better stuff in the future by buying me a coffee

Also, if you liked this repo, consider checking out my other projects, that would be real cool!

Attributions and special thanks


About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK