This is a read-only snapshot of the ComputerCraft forums, taken in April 2020.
Danny's profile picture

[OpenPeripherals] Documentation?

Started by Danny, 22 July 2014 - 07:57 PM
Danny #1
Posted 22 July 2014 - 09:57 PM
I was looking for a general reference for OpenPeripherals. Does anyone know where one is? It'd be greatly appreciated.
Thanks in advance.
Cranium #2
Posted 22 July 2014 - 10:31 PM
There is none, actually. All OpenPeripheral documentation is in game.
Through the shell, use openp/docs <side> for info about a peripheral.

In my opinion, this is absolutely stupid, and makes it incredibly difficult for people to write anything using OpenPeripheral.

EDIT: Also, I edited your title to assist those who use the search function to get an answer to your question.
Edited on 22 July 2014 - 08:37 PM
Danny #3
Posted 22 July 2014 - 10:41 PM
Alright. Thanks, I agree that is REALLY stupid that there is no online documentation.
flaghacker #4
Posted 23 July 2014 - 08:14 AM
The in-game documentation tells you all you need: arguments and returns. The method name is always very descriptive about what it does
theoriginalbit #5
Posted 23 July 2014 - 08:54 AM
look, tbh there's nothing wrong with the in-game documentation, the problem is with the format it is being presented to you, the user; yes I recognise the program is bad, but I don't have the time, will, or need to update it, nor does anyone else in OpenMods. As it is a bad one, there are programs on these forums that make the in-game documentation system better.
The main thing people complain about is that you cannot look up documentation about things that aren't attached to the computer, but truth is, if you're going to use it, it's attached to the computer! The way the documentation is served isn't going to change, no matter how much you complain about it; the format it is in is quite easy for us to supply modify/fix, and always makes sure you have the up-to-date information for the version you're using, if we were to have a website, and make changes, and update it to the latest version, people would complain that they cannot access old documentation, if we stuck back at those versions people with the new version would complain, using in-game documentation that takes data from the mod means the correct information is provided. If you don't like the program it is quite easy for anyone to write their own website to parse the data, or alternatively you can write your own in-game program to improve on the process.
bigbrainiac10 #6
Posted 23 July 2014 - 08:54 AM
The in-game documentation tells you all you need: arguments and returns. The method name is always very descriptive about what it does

This is true, however it would be much more convenient if there was Online Documentation. It would also uncover peripherals that some people never knew existed.
hilburn #7
Posted 23 July 2014 - 09:37 AM
My one issue with the ingame documentation is that it doesn't use some sort of paged printout as most things with an inventory will already be close to the 19 lines displayable at once, so I made a program to do that and added it to ROM.
Other than that I really like it. It's simple, easy to use, and after a while you can pretty much guess what the methods are going to be anyway as there are are a standard selection of them for Inventory, Tank and Power which covers 90% of things quite happily. The problem with online documentation is that, as theoriginalbit (who I should really stop reading as theoriginalblt because it just makes me hungry) says, you get big issues with different versions, for example FTB Monster runs 0.4.0 whereas DW20 runs 0.3.3. Curating an online system to cover all of that would drive me nuts, especially when there is a working method that tells them all of this stuff anyway as and when it becomes relevant. Frankly if you have the time and inclination to mess around with this magical mod, you should have no trouble looking up the documentation
Bomb Bloke #8
Posted 23 July 2014 - 10:03 AM
look, tbh there's nothing wrong with the in-game documentation, the problem is with the format it is being presented to you, the user;

I would say that format is an aspect of the documentation - they're the same thing. And I can live with the format. The real problem is the availability.

People come here asking how to use peripheral X, and I have trouble finding a version of OpenPeripheral that even lets you use X, let alone a version that shares the same usage.

It's like someone sat down and thought, "hmm, how can I rig OpenPeripheral so that beginner programmers - the crowd ComputerCraft is aimed at - have no hope of working out how to get into this side mod on their own?". I thought mikeemoo was trying to shut the whole project down at the time. Truth be told, I've yet to be dissuaded of that opinion.