prinzstani / CookieBot

Automatic Playthrough for Cookie Clicker
GNU General Public License v3.0
51 stars 34 forks source link

[Steam] Easy compatibility with Steam #74

Closed thelmexx closed 2 years ago

thelmexx commented 3 years ago

Cookie Clicker mods on Steam appear to be loaded in the form of two files, info.txt (used like a .json file) and main.js, so simply adding these as a release would make super easy for users to install.

mockup info.txt:

{
    "Name": "CookieBot",
    "ID": "cookie bot",
    "Author": "prinzstani",
    "Description": "Cookie Bot is an add-on you can load into Cookie Clicker, that will do an automatic playthrough for Cookie Clicker.",
    "ModVersion": 2.030,
    "GameVersion": 2.042,
    "Date": "13/09/2021",
    "Dependencies": [],
    "Disabled": 1
}

and main.js works exactly like the js console in browsers: Game.LoadMod('https://prinzstani.github.io/CookieBot/cookieAutoPlayBeta.js')

Not going to make any comment on the morals of it, but you can also re-enable Steam achievements by appending "AllowSteamAchievs": 1 to the end of info.txt (this fixes #72 )

prinzstani commented 3 years ago

I do not intend to handle Steam issues myself, but please create a pull request with the needed changes, and I will accept it and make it into a release.

Kikithecat12345 commented 3 years ago

I do not intend to handle Steam issues myself, but please create a pull request with the needed changes, and I will accept it and make it into a release.

CookieBot Beta.zip CookieBot.zip These 2 .zips are ready-made versions of the mod that auto-update. (like the bookmarklet) They just need to be made into a release.

prinzstani commented 3 years ago

I am a bit unsure how to handle this in git. It seems like the zip file is straightforward and does not change lot. We probably should create a folder for all the files (info and js). As we now have the same information several places, we might also start to consider some build script. I do not think we want to deliver the beta in a release - currently only real releases are distributed and beta is the current state. So maybe we provide the beta zip in a folder and the main zip is then released in a git release?

Kikithecat12345 commented 2 years ago

The steam version has finally gotten Steam Workshop support, would this be a good time to add it there?

prinzstani commented 2 years ago

I have added the two zip files into the main bot folder. Maybe someone could provide an updated description of how to use it in the README.

Kikithecat12345 commented 2 years ago

As we now have the same information several places, we might also start to consider some build script.

I can make a quick and dirty node.js build script if that helps.

prinzstani commented 2 years ago

After reconsidering, I feel we do not need a build script after all, as the zip files will work independently of the changes in the code. The only thing that would be nice is a decent description of using the zip files for Steam.

Kikithecat12345 commented 2 years ago

I can do that, should I also add the .zip files to the repository? @prinzstani

prinzstani commented 2 years ago

The zip files are already there in the main folder. When you add a description we should be done.

Kikithecat12345 commented 2 years ago

I can also add this to the steam workshop, if you want. This will allow more people to see it, and also make it trivial to install. I want your permission to do this though, @prinzstani

prinzstani commented 2 years ago

I understand that this would put the bot into the tools available in Steam. That sounds like a great idea, just go ahead.