Skip to content
This repository has been archived by the owner on Jul 1, 2019. It is now read-only.

First Example Project Guide #15

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Conversation

Xenmai
Copy link

@Xenmai Xenmai commented Mar 25, 2019

Puts some basic concepts into practice, helping users create a simple halloween event for their server.

Introduction
============

In this first example project, we'll start with the basics. The following topics will be covered:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence implies that this project itself will be teaching users the following topics. My assumption is that this project will be utilizing and/or enforcing those topics, so the wording should be clearer to avoid that confusion.

* :doc:`Section 2.1 - An Introduction to Tags </docs/basics-of-scripting/an-introduction-to-tags>`
* :doc:`Section 2.2 - The Basics of Denizen Commands </docs/basics-of-scripting/basics-of-denizen-commands>`
* :doc:`Section 2.7 - Your First World Script </docs/basics-of-scripting/your-first-world-script>`
* **[TODO: Add FOREACH section reference]**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should probably add a couple more TODOs, particularly for advanced tag construction, debugging, and browsing the documentation (yes, I'm planning on adding a subsection for that under Section 1).


.. __: https://one.denizenscript.com/denizen/logs

1. First Steps
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a little unsure about this section name. Can it be a little more specific, or less general?

@MusicScore
Copy link
Contributor

Generally speaking, throughout the document there tends to be multiple places where there's a lot of emphasis text. I'd like for the emphasis text to be reserved for the more "critical" information that the user must absolutely pay attention to.

.. __: https://one.denizenscript.com/denizen/evts/clicks%20block

.. note::
This tutorial assumes our *Hub world* is in fact called ``Hub``.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This note might be a little out of place. It may be better to just mention in the paragraph at line 40 that this can be done in any world, but that you're using a world named "Hub" as an example world that the user may use.


Let's go ahead and specify ``diamond`` as the first argument of our give command. We don't have to worry about who to
give the diamond to, as the command will target the linked player by default. That is, the player that triggered the
event. The full command line will then be ``- give diamond``.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There shouldn't be a real need to say "the player that triggered the event" since that part would be covered in a section on how queues work.

Though that being said, that adds another thing to the list of concepts that the user should be familiar with before starting this project

@MusicScore
Copy link
Contributor

Hi. It's been two months.

If there is no additional changes or replies within the next week, I will assume that this PR is no longer being maintained and I will close it. Thanks.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants