CC: Tweaked

CC: Tweaked

42M Downloads

Block Setup Documentation - ingame or on website

LordHelmchen opened this issue ยท 4 comments

commented

I was missing some basic block guides. The programming API is well documented, but without knowing what to look for it took quite a while to find out, that I have to right click a modem for it to work. I simply didn't understand why modems would not do anything or if I have to write messages or do remote calls on the modem or if I have to set up a computer next to each inventory/peripheral I want to modify.

#1023 (comment) has picture that explained basic networking and made sure, that I was on the right track. In the mentioned issue the modems were red, which was different from mine.

After I found out about it, I looked for someone else mentioning it:
http://www.computercraft.info/forums2/index.php?/topic/11244-151-using-network-cables-for-dummies/ is a small example that mentions this important fact.

A small block setup + wrap peripheral + transfer item example would make it much easier to understand how CC works in general.

commented

Adding to this, an example GPS setup would also be useful.

The documentation system does support wiki/guide like entries (go to tweaked.cc and scroll the index to the bottom), so one just needs to make a PR assign a new file to https://github.com/cc-tweaked/CC-Tweaked/tree/mc-1.16.x/doc/guides. Just a note that legally we can't copy from the old wikis, so someone who already knows how to do some of this stuff would have to write it.

commented

Going to try to make a couple of PRs covering this kind of stuff. It's probably going to take me a while though.

commented

What I'm currently writing:

  • using startup files
  • setting up GPS
  • using modems for communication and connecting peripherals

I might do these as separate PRs

commented

Worth mentioning that there's some stuff about monitors in the introduction to the peripheral API, but it's not great - could probably do with fleshing out or cross-referencing with other pages.