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

Block Setup Documentation - ingame or on website #1068

Closed
LordHelmchen opened this issue Apr 13, 2022 · 4 comments
Closed

Block Setup Documentation - ingame or on website #1068

LordHelmchen opened this issue Apr 13, 2022 · 4 comments
Labels
area-Documentation Improving/fixing documentation enhancement An extension of a feature or a new feature.

Comments

@LordHelmchen
Copy link

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.

@LordHelmchen LordHelmchen added the enhancement An extension of a feature or a new feature. label Apr 13, 2022
@Lupus590
Copy link
Contributor

Lupus590 commented Apr 13, 2022

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.

@SquidDev SquidDev added the area-Documentation Improving/fixing documentation label Apr 13, 2022
@Lupus590
Copy link
Contributor

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

@Lupus590
Copy link
Contributor

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

@SquidDev
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Documentation Improving/fixing documentation enhancement An extension of a feature or a new feature.
Projects
None yet
Development

No branches or pull requests

3 participants