https://github.com/garryspins/gmod-fetch

GFetch is a neofetch-clone for Garry's Mod
https://github.com/garryspins/gmod-fetch

Last synced: about 2 months ago
JSON representation

GFetch is a neofetch-clone for Garry's Mod

• Host: GitHub
• URL: https://github.com/garryspins/gmod-fetch
• Owner: garryspins
• License: gpl-3.0
• Created: 2020-11-21T00:37:35.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2020-11-21T17:24:01.000Z (about 4 years ago)
• Last Synced: 2024-08-04T04:06:52.264Z (5 months ago)
• Language: Lua
• Size: 74.2 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-fetch - gmod-fetch - GFetch is a neofetch-clone for Garry's Mod. `Lua` (Miscellaneous / MacOS Only)

README

        


  



# GFetch

GFetch is a multi-purpose, highly extensible system information commandline interface for Garry's Mod.


With overcomplicated CLI features it promises to be fun for 10 minutes then youll forget its there.

Features

  

- Easy, Clean, Object Based API.

- Provides Easy Access to Useful Information.

- Neat Map Image.

- Licensed under GPLv3, if it doesnt have a feature youd like you can add it.

Basic Usage

Just type `gfetch` in console and itll do its thing.

 

For more advanced commands type `-h` as an option

Documentation

  

  If you dont understand a function look at the gfetch_modules directory for examples.

   #### GFetch Methods

   ---

  `GFetch:AddModule(Str name,Str short)` : Creates a Module : Shared


  

  `String name`  :  Full Name of the module (aka 'Pretty Name')


  `String short` :  Short Name of the module, This is the name that people will see and use to disable it in the commandline


   


   Returns       :  ModuleObj

  

  

  `GFetch:AddCommand(Str full,Str short,Str desc,Func func,Bool blocking)` : Creates a command : Shared


  `String full`  :  Full Command (Should start with `--`)


  `String short` :  Short Command (Should start with `-`)


  `String Descr` :  Description


  `Func Func`    :  The commands function - Called with the current running commands configurations, Next argument


  `Bool Blocking`:  Should the command block the output of the fetch, this can also be done by returning `true` from the `Func` argument


   


   


   


   #### ModuleObj Methods

   ---

   ! Means Set or Get.



   

   Name of the Module


   `!Name()`



   Short Name of the Module


   `!Short()`



   Description of the Module


   `!Description()`



   Function of the Module


   `!Function()`



   State that the Module should be ran on (CLIENT/SERVER)


   `!State()`



Images