Skip to content

Conversation

mudlet-machine-account
Copy link
Collaborator

Package information:

  • Name: Urtellik UL
  • Title: Urtellik's UL client
  • Version: 0.1.0
  • Author: Urtellik
  • Created: 2025-03-29T19:42:52-04:00

TemplateProject

TemplateProject by ShrinkingViolet

This is a template project created by muddler. It's meant to give you the basic skeleton to get started.
It is not a complete project, nor does it provide an example of every type of trigger scenario or keybinding corner case. It would make it even more difficult to clear out to make way for your own items.
It will properly muddle and create an mpackage, however.
For more detailed information on describing your triggers, scripts, etc in the json files, please see the muddler wiki

This space is where I would normally put the description of my package and what it does/why I made it. But if you have a README format you already like, feel free to ignore all this.

Installation

It's a good idea to provide installation instructions. I like to include a command they can copy/paste into the Mudlet commandline. Like

lua uninstallPackage("packageName") installPackage("https://somedomain.org/path/to/my/package/packageName.mpackage")

Usage

Brief introduction to the overall usage. Then break it down to specifics

Aliases

  • alias1 <param1>
    • description of what the alias does, and what param1 is if it exists
      • example usage1
      • optional example usage2, etc
  • alias 2
    • and so on, and so forth

API

  • `functionName(param1, param2)
    • Then, do the same thing for any Lua API which you want them to be able to use.
    • This part can be skipped if you have separate API documentation, but keep in mind the README.md file is accessible from the package manage in Mudlet, so this allows you to provide documentation within Mudlet, to a degree.

Final thoughts, how to contribute, thanks, things like that

I like to put anything which doesn't fit with the above stuff here, at the end. It keeps the documentation like stuff at the top.

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here: https://app.greptile.com/review/github.

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

@ZookaOnGit
Copy link
Collaborator

ZookaOnGit commented Mar 30, 2025

Thanks for your submission. Can you please provide a package description for the package? It looks like the one submitted is a stock template which will make searching for your package with mpkg difficult.

@urtellik
Copy link

urtellik commented Apr 26, 2025

Apologies for that. I did not realize when I clicked the button that it would open a PR and begin a manual review process. I assumed I'd be able to push further updates at will. Please close this PR. I think it will be simpler for me to just direct my users to a download location I control.

@vadi2
Copy link
Member

vadi2 commented Apr 27, 2025

You definitely can push further updates to a package! Just make another submission via the website to do that. Here's an example of such a package update.

@urtellik
Copy link

urtellik commented Apr 27, 2025 via email

@ZookaOnGit ZookaOnGit closed this Apr 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants