Giter Site home page Giter Site logo

rodelph / archivist Goto Github PK

View Code? Open in Web Editor NEW
0.0 4.0 0.0 266.39 MB

ARchivist is a software that allows the user to access hyperlinks that are printed on physical papers using Augmented Reality.

C# 33.00% ShaderLab 43.74% HLSL 7.38% Python 10.11% C++ 5.77%

archivist's Introduction

ARchivist

This project was made by :

First Name Last Name Student ID
Amine Naqi 0562497
Mable Rajan 0608648
Sean Victor Scofield 0613347

Overview

This project contains the code for the ARchivist prototype built for the Next Generation User Interfaces course at VUB. It was written by Amine Naqi, Mable Rajan, and Sean Scofield.

ARchivist is a project that is meant to make hyperlinks visible and interactive on physical documents. In its current state, it can be used to create an "augmented" document from a website page (which generates a PDF of that website page containing a QR code and AR marker on each page). By scanning those QR codes, users of the ARchivist mobile application can them view and interact with a document's hyperlinks via augmented reality.

The code in this repo is separate into 2 sub-parts, each containing their own respective sub-directories and README files:

  • ARchivist document generator: Python code to be run on a computer in order to generate augmented documents.
    • More info can be found here
  • ARchivist mobile application: Unity project containing the code for an Android/iPhone mobile application that can be used to read and interact with these augmented documents.
    • More info can be found here

In addition, a pre-built Android APK of the mobile application has been included for ease of testing this prototype. Note, however, that the AR tracking performance is noticeably better on iPhone. For both Android and iPhone, the Unity project can be opened and used to package the application into an Android or iPhone app (the latter requiring MacOS).

Storage Solution

We are currently using JsonBin.io for storing the data that the QR codes in our augmented documents link to. We ultimately cut some corners in order to get a workable solution with minimal effort, that way we could focus on more important aspects of this project. We go into more detail in our final report, but some of the negative aspects of this current approach are that it is centralized and we also didn't address security of access.

We created a JsonBin.io account solely for use with this project, and have provided "read" and "write" access keys in plaintext to our mobile application code and document generation code, respectively. Furthermore, we list the username and password of that account here for ease of visibility into the stored files themselves as well as troubleshooting (this is normally a VERY BAD security flaw that should not be done):

JsonBin.io user: [email protected]

JsonBin.io pwd: tHEmEMERgANG1997

Compatibility

This project is meant to be compatible with the following operating systems (although macOS is required for building an iPhone app from the mobile application):

  • Windows
  • Linux
  • macOS

archivist's People

Contributors

rodelph avatar

Watchers

Maxim Van de Wynckel avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.