Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wiki page on how to use install and use the CLI #70

Open
Vedvod opened this issue Jun 12, 2021 · 1 comment
Open

Wiki page on how to use install and use the CLI #70

Vedvod opened this issue Jun 12, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation/wiki
Milestone

Comments

@Vedvod
Copy link

Vedvod commented Jun 12, 2021

Hello, I am quite unsure of how this module is meant to be used. I am running on python 3.9.2 on Windows 10. Firstly, I am unsure of how to import the module. import minecraft-mod-manager does not work, which is somewhat expected, but import minecraft_mod_manager does. There is no indication that I could find that this is how to import it, if it even is the way to import it, if it even is meant to be imported. Then, if I try to use one of the example code things, minecraft-mod-manager install mod_name, rather than tell me that there is no mod called mod_name or something, it instead throws a SyntaxError exception. I also tried the example mmm update with the same result. I really can not at all understand how this is meant to be used, and how the commands are meant to work. Perhaps an example file/multi-line code block thing that shows the process for installing a mod called mod_name would clarify this process? It is entirely possible (and likely) that I'm just being a derp and missing an obvious thing here, and if I am, I apologise, but an example code would clarify the process IMO.

@Vedvod Vedvod added the enhancement New feature or request label Jun 12, 2021
@Senth Senth added question Further information is requested from the reporter and removed enhancement New feature or request labels Jun 13, 2021
@Senth
Copy link
Owner

Senth commented Jun 13, 2021

Hi Vedvod,

The mod is meant to be used as a command (running from cmd.exe). However, in Windows (and other OSes) you need to add a PATH variable to your current python installation, to be able to run it from anywhere.

Windows

  1. Search and open environment variables
    image
  2. Open
    image
  3. Select user variable Path and edit it
    image
  4. Add the Python39\Scipts path. You can see where mine is located in Windows. You probably only have to replace the username senth with your username since you're also using Python 3.9.
    image
  5. Press okay to save the variables.
  6. Open up a new cmd.exe (you have to open up a new one)
  7. Try running minecraft-mod-manager --help (mmm or mcman short command hasn't been released yet). Highlighted in yellow.
    image

Hope this helps :)

The plan in the future is to make it more accessible, hopefully before Minecraft 1.18

@Senth Senth changed the title Unclear how to use (or not working (but unlikely that)) Unclear how to use Jun 13, 2021
@Senth Senth changed the title Unclear how to use Wiki page on how to use install and use the CLI Jun 13, 2021
@Senth Senth added CLI documentation Improvements or additions to documentation/wiki and removed question Further information is requested from the reporter labels Jun 13, 2021
@Senth Senth added this to the 2.0.0 milestone Jun 13, 2021
@Senth Senth removed the CLI label Mar 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation/wiki
Projects
None yet
Development

No branches or pull requests

2 participants